Skip to content

Commit

Permalink
Replaced internal .html links with .md extension
Browse files Browse the repository at this point in the history 
Find: (\([^:\)]+\.)html\)

Replace: $1md\)
  • Loading branch information
@breandan
breandan authored and breandan committed Aug 6, 2015
1 parent 8f2edb4 commit 7b75f3a
Show file tree
Hide file tree
Showing 59 changed files with 228 additions and 228 deletions.
18 changes: 9 additions & 9 deletions basics.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ title: Quick Start Guide
This section covers the basics of working with *IntelliJ Platform*.
It will familiarize you with the working environment, project structure, and frequently used API components.

* [Main Types of IntelliJ IDEA Plugins](basics/types_of_plugins.html)
* [Getting Started](basics/getting_started.html)
* [Architectural Overview](basics/architectural_overview.html)
* [Project Structure](basics/project_structure.html)
* [Check Out And Build Community Edition](basics/checkout_and_build_community.html)
* [IDE Settings, Caches, Logs, and Plugins](basics/settings_caches_logs.html)
* [Indexing and PSI Stubs](basics/indexing_and_psi_stubs.html)
* [Run Configurations](basics/run_configurations.html)
* [Testing Plugins](basics/testing_plugins.html)
* [Main Types of IntelliJ IDEA Plugins](basics/types_of_plugins.md)
* [Getting Started](basics/getting_started.md)
* [Architectural Overview](basics/architectural_overview.md)
* [Project Structure](basics/project_structure.md)
* [Check Out And Build Community Edition](basics/checkout_and_build_community.md)
* [IDE Settings, Caches, Logs, and Plugins](basics/settings_caches_logs.md)
* [Indexing and PSI Stubs](basics/indexing_and_psi_stubs.md)
* [Run Configurations](basics/run_configurations.md)
* [Testing Plugins](basics/testing_plugins.md)
2 changes: 1 addition & 1 deletion basics/action_system.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ public class MyPluginRegistration implements ApplicationComponent {
```

Note, that the sample ```TextBoxes``` class is described in
[Getting Started with Plugin Development](/basics/getting_started.html).
[Getting Started with Plugin Development](/basics/getting_started.md).

To ensure that your plugin is initialized on IDEA start-up, make the following changes to the `<application-components>` section of the plugin.xml file:

Expand Down
12 changes: 6 additions & 6 deletions basics/architectural_overview.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ and then returning to this document.

The following subjects are covered:

* [General Threading Rules](architectural_overview/general_threading_rules.html)
* [General Threading Rules](architectural_overview/general_threading_rules.md)

* [Virtual Files](architectural_overview/virtual_file.html)
* [Virtual Files](architectural_overview/virtual_file.md)

* [Documents](architectural_overview/documents.html)
* [Documents](architectural_overview/documents.md)

* [PSI Files](architectural_overview/psi_files.html)
* [PSI Files](architectural_overview/psi_files.md)

* [File View Providers](architectural_overview/file_view_providers.html)
* [File View Providers](architectural_overview/file_view_providers.md)

* [Psi Elements](architectural_overview/psi_elements.html)
* [Psi Elements](architectural_overview/psi_elements.md)
2 changes: 1 addition & 1 deletion basics/architectural_overview/psi_elements.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ Most likely you should use PsiTreeUtil.getParentOfType() to find the element you

## What can I do with PSI elements?

See [PSI Cook Book](/basics/psi_cookbook.html)
See [PSI Cook Book](/basics/psi_cookbook.md)
12 changes: 6 additions & 6 deletions basics/getting_started.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ To become more familiar with *IntelliJ IDEA*, please refer to



* [Setting Up a Development Environment](getting_started/setting_up_environment.html)
* [Setting Up a Development Environment](getting_started/setting_up_environment.md)

* [Creating a Plugin Project](getting_started/creating_plugin_project.html)
* [Creating a Plugin Project](getting_started/creating_plugin_project.md)

* [Build Number Ranges](getting_started/build_number_ranges.html)
* [Build Number Ranges](getting_started/build_number_ranges.md)

* [Running and Debugging a Plugin](getting_started/running_and_debugging_a_plugin.html)
* [Running and Debugging a Plugin](getting_started/running_and_debugging_a_plugin.md)

* [Deploying a Plugin](getting_started/deploying_plugin.html)
* [Deploying a Plugin](getting_started/deploying_plugin.md)

* [Plugin Compatibility with IntelliJ Platform Products](getting_started/plugin_compatibility.html)
* [Plugin Compatibility with IntelliJ Platform Products](getting_started/plugin_compatibility.md)
4 changes: 2 additions & 2 deletions basics/indexing_and_psi_stubs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Plugin developers can use the existing indexes built by the IDE itself, as well

It supports two main types of indexes:

* [File-based indexes](/basics/indexing_and_psi_stubs/file_based_indexes.html)
* [Stub indexes](/basics/indexing_and_psi_stubs/stub_indexes.html)
* [File-based indexes](/basics/indexing_and_psi_stubs/file_based_indexes.md)
* [Stub indexes](/basics/indexing_and_psi_stubs/stub_indexes.md)

File-based indexes are built directly over the content of files.
Stub indexes are built over serialized *stub trees*.
Expand Down
16 changes: 8 additions & 8 deletions basics/plugin_structure.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ title: Plugin Structure

Click the following topics to learn more about the plugin system structure and plugin lifecycles:

* [Plugin Content](plugin_structure/plugin_content.html)
* [Plugin Content](plugin_structure/plugin_content.md)

* [Plugin Class Loaders](plugin_structure/plugin_class_loaders.html)
* [Plugin Class Loaders](plugin_structure/plugin_class_loaders.md)

* [Plugin Components](plugin_structure/plugin_components.html)
* [Plugin Components](plugin_structure/plugin_components.md)

* [Plugin Extensions and Extension Points](plugin_structure/plugin_extensions_and_extension_points.html)
* [Plugin Extensions and Extension Points](plugin_structure/plugin_extensions_and_extension_points.md)

* [Plugin Actions](plugin_structure/plugin_actions.html)
* [Plugin Actions](plugin_structure/plugin_actions.md)

* [Plugin Services](plugin_structure/plugin_services.html)
* [Plugin Services](plugin_structure/plugin_services.md)

* [Plugin Configuration File](plugin_structure/plugin_configuration_file.html)
* [Plugin Configuration File](plugin_structure/plugin_configuration_file.md)

* [Plugin Dependencies](plugin_structure/plugin_dependencies.html)
* [Plugin Dependencies](plugin_structure/plugin_dependencies.md)
2 changes: 1 addition & 1 deletion basics/plugin_structure/plugin_components.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ However, if the workspace option in the plugin.xml file is set to _true_, the co
* Module-level components save their state to the module (.iml) file.

For more information and samples, refer to
[Persisting State of Components](/basics/persisting_state_of_components.html).
[Persisting State of Components](/basics/persisting_state_of_components.md).

### Defaults

Expand Down
2 changes: 1 addition & 1 deletion basics/psi_cookbook.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: PSI Cookbook


This page gives a list of recipes for the most common operations for working with the PSI (Program Structure Interface) of IntelliJ Platform. Unlike
[Developing Custom Language Plugins](/reference_guide/custom_language_support.html),
[Developing Custom Language Plugins](/reference_guide/custom_language_support.md),
it talks about working with the PSI of existing languages (such as Java).

### How do I find a file if I know its name but don't know the path?
Expand Down
4 changes: 2 additions & 2 deletions basics/run_configurations.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ You can provide UI for the user to specify execution options, as well as an opti

Classes used to manipulate *IntelliJ IDEA's* run configurations can be split into the following groups:

* [Run configuration management](/basics/run_configurations/run_configuration_management.html)
* [Run configuration management](/basics/run_configurations/run_configuration_management.md)
This includes creation, persistence, and modification.

* [Execution](/basics/run_configurations/run_configuration_execution.html)
* [Execution](/basics/run_configurations/run_configuration_execution.md)

This diagram shows the main classes related to **IntelliJ IDEA** run configurations

Expand Down
12 changes: 6 additions & 6 deletions basics/testing_plugins.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@ for plugin UI testing, but we don't use either of them and cannot provide any gu
Internally, we use manual testing for testing our Swing UIs.


* [Tests and Fixtures](/basics/testing_plugins/tests_and_fixtures.html)
* [Light and Heavy Tests](/basics/testing_plugins/light_and_heavy_tests.html)
* [Test Project and Testdata Directories](/basics/testing_plugins/test_project_and_testdata_directories.html)
* [Writing Tests](/basics/testing_plugins/writing_tests.html)
* [Testing Highlighting](/basics/testing_plugins/testing_highlighting.html)
* [Tests and Fixtures](/basics/testing_plugins/tests_and_fixtures.md)
* [Light and Heavy Tests](/basics/testing_plugins/light_and_heavy_tests.md)
* [Test Project and Testdata Directories](/basics/testing_plugins/test_project_and_testdata_directories.md)
* [Writing Tests](/basics/testing_plugins/writing_tests.md)
* [Testing Highlighting](/basics/testing_plugins/testing_highlighting.md)


Check out
[this step-by-step tutorial](/tutorials/writing_tests_for_plugins.html)
[this step-by-step tutorial](/tutorials/writing_tests_for_plugins.md)
teaching how to write and run automated tests for your custom language plugin (source code included).

2 changes: 1 addition & 1 deletion basics/types_of_plugins.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Custom language support provides basic functionality for working with a particul
* Intention actions

Refer to the
[Custom Language Support Tutorial](/tutorials/custom_language_support_tutorial.html)
[Custom Language Support Tutorial](/tutorials/custom_language_support_tutorial.md)
to learn more about the topic.

## Framework Integration
Expand Down
10 changes: 5 additions & 5 deletions index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ title: IntelliJ Platform SDK Documentation

## Welcome to the IntelliJ Platform SDK Documentation!

Here you can find [basic information](basics.html) about the *IntelliJ Platform SDK*, in particular how to
**[get started](basics/getting_started.html)** with developing plugins for IntelliJ IDEA and other JetBrains IDEs.
Here you can find [basic information](basics.md) about the *IntelliJ Platform SDK*, in particular how to
**[get started](basics/getting_started.md)** with developing plugins for IntelliJ IDEA and other JetBrains IDEs.

More details about specific development topics can be found in the
[Architecture Reference Guide](reference_guide.html).
[Architecture Reference Guide](reference_guide.md).

A set of
**[step-by-step tutorials](tutorials.html)**
**[step-by-step tutorials](tutorials.md)**
with code samples will lead you through the common use cases for *IntelliJ Platform SDK*.


The [Plugin Development FAQ](faq.html)
The [Plugin Development FAQ](faq.md)
section contains a series of issues commonly discussed on our
[Open API and Plugin Development](https://devnet.jetbrains.com/community/idea/open_api_and_plugin_development) forums.

Expand Down
22 changes: 11 additions & 11 deletions reference_guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ title: Architecture Reference Guide

This documentation section contains more in-depth explanation of different API components.
If you are not familiar with *IntelliJ Platform* API please refer to
[Basics](basics.html)
[Basics](basics.md)
section.

* [Project Model](reference_guide/project_model.html)
* [Project Wizard](reference_guide/project_wizard.html)
* [Custom Language Support](reference_guide/custom_language_support.html)
* [Frameworks and External APIs](reference_guide/frameworks_and_external_apis.html)
* [VCS Integration Plugins](reference_guide/vcs_integration_for_plugins.html)
* [Localization Guide](reference_guide/localization_guide.html)
* [Messaging Infrastructure](reference_guide/messaging_infrastructure.html)
* [Multiple Carets](reference_guide/multiple_carets.html)
* [Color Scheme Management](reference_guide/color_scheme_management.html)
* [User Interface Components](user_interface_components/user_interface_components.html)
* [Project Model](reference_guide/project_model.md)
* [Project Wizard](reference_guide/project_wizard.md)
* [Custom Language Support](reference_guide/custom_language_support.md)
* [Frameworks and External APIs](reference_guide/frameworks_and_external_apis.md)
* [VCS Integration Plugins](reference_guide/vcs_integration_for_plugins.md)
* [Localization Guide](reference_guide/localization_guide.md)
* [Messaging Infrastructure](reference_guide/messaging_infrastructure.md)
* [Multiple Carets](reference_guide/multiple_carets.md)
* [Color Scheme Management](reference_guide/color_scheme_management.md)
* [User Interface Components](user_interface_components/user_interface_components.md)
34 changes: 17 additions & 17 deletions reference_guide/custom_language_support.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,26 +14,26 @@ source code.


If you prefer a full example to the detailed description offered on this page, please check out a step-by-step tutorial how to define custom language support on example of ".properties" files:
[Custom Language Support Tutorial](/tutorials/custom_language_support_tutorial.html)
[Custom Language Support Tutorial](/tutorials/custom_language_support_tutorial.md)

Providing custom language support includes the following major steps:

* [Registering File Type](/reference_guide/custom_language_support/registering_file_type.html)
* [Implementing Lexer](/reference_guide/custom_language_support/implementing_lexer.html)
* [Implementing Parser and PSI](/reference_guide/custom_language_support/implementing_parser_and_psi.html)
* [Syntax Highlighting and Error Highlighting](/reference_guide/custom_language_support/syntax_highlighting_and_error_highlighting.html)
* [References and Resolve](/reference_guide/custom_language_support/references_and_resolve.html)
* [Code Completion](/reference_guide/custom_language_support/code_completion.html)
* [Find Usages](/reference_guide/custom_language_support/find_usages.html)
* [Rename Refactoring](/reference_guide/custom_language_support/rename_refactoring.html)
* [Safe Delete Refactoring](/reference_guide/custom_language_support/safe_delete_refactoring.html)
* [Code Formatter](/reference_guide/custom_language_support/code_formatting.html)
* [Code Inspections and Intentions](/reference_guide/custom_language_support/code_inspections_and_intentions.html)
* [Structure View](/reference_guide/custom_language_support/structure_view.html)
* [Surround With](/reference_guide/custom_language_support/surround_with.html)
* [Go to Class and Go to Symbol](/reference_guide/custom_language_support/go_to_class_and_go_to_symbol.html)
* [Documentation](/reference_guide/custom_language_support/documentation.html)
* [Additional Minor Features](/reference_guide/custom_language_support/additional_minor_features.html)
* [Registering File Type](/reference_guide/custom_language_support/registering_file_type.md)
* [Implementing Lexer](/reference_guide/custom_language_support/implementing_lexer.md)
* [Implementing Parser and PSI](/reference_guide/custom_language_support/implementing_parser_and_psi.md)
* [Syntax Highlighting and Error Highlighting](/reference_guide/custom_language_support/syntax_highlighting_and_error_highlighting.md)
* [References and Resolve](/reference_guide/custom_language_support/references_and_resolve.md)
* [Code Completion](/reference_guide/custom_language_support/code_completion.md)
* [Find Usages](/reference_guide/custom_language_support/find_usages.md)
* [Rename Refactoring](/reference_guide/custom_language_support/rename_refactoring.md)
* [Safe Delete Refactoring](/reference_guide/custom_language_support/safe_delete_refactoring.md)
* [Code Formatter](/reference_guide/custom_language_support/code_formatting.md)
* [Code Inspections and Intentions](/reference_guide/custom_language_support/code_inspections_and_intentions.md)
* [Structure View](/reference_guide/custom_language_support/structure_view.md)
* [Surround With](/reference_guide/custom_language_support/surround_with.md)
* [Go to Class and Go to Symbol](/reference_guide/custom_language_support/go_to_class_and_go_to_symbol.md)
* [Documentation](/reference_guide/custom_language_support/documentation.md)
* [Additional Minor Features](/reference_guide/custom_language_support/additional_minor_features.md)


Please ask questions or suggest missing topics in [plugin development forum](https://devnet.jetbrains.com/community/idea/open_api_and_plugin_development).
6 changes: 3 additions & 3 deletions reference_guide/frameworks_and_external_apis.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ title: Frameworks and External APIs
The following section explains how to access components of external frameworks from inside the *IntelliJ Platform*.
This includes:

* [XML DOM API](/reference_guide/frameworks_and_external_apis/xml_dom_api.html)
* [Spring API](/reference_guide/frameworks_and_external_apis/spring_api.html)
* [External Builder API and Plugins](/reference_guide/frameworks_and_external_apis/external_builder_api.html)
* [XML DOM API](/reference_guide/frameworks_and_external_apis/xml_dom_api.md)
* [Spring API](/reference_guide/frameworks_and_external_apis/spring_api.md)
* [External Builder API and Plugins](/reference_guide/frameworks_and_external_apis/external_builder_api.md)
2 changes: 1 addition & 1 deletion reference_guide/frameworks_and_external_apis/spring_api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ _Version 14_: ```com.intellij.spring.model.utils.SpringModelSearchers#doesBeanEx
_Version 14_: implement ```SpringInfrastructureBean```, such beans obtain special icon and can be filtered in various places in UI

### XML Configuration
All support for XML-based Spring configuration files is provided via [DOM-API](xml_dom_api.html).
All support for XML-based Spring configuration files is provided via [DOM-API](xml_dom_api.md).

##### Add support for additional Spring namespace
See EP ```com.intellij.spring.dom.SpringCustomNamespaces```, registered namespace-key must match the one registered with your DOM elements via ```@Namespace```.
Expand Down
10 changes: 5 additions & 5 deletions reference_guide/project_model.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ This document explains how you can explore and change the structure of projects

Main project structure components are:

* [Project](/reference_guide/project_model/project.html)
* [Project](/reference_guide/project_model/project.md)
itself

* [Module](/reference_guide/project_model/module.html)
* [Module](/reference_guide/project_model/module.md)

* [SDK](/reference_guide/project_model/sdk.html)
* [SDK](/reference_guide/project_model/sdk.md)

* [Library](/reference_guide/project_model/library.html)
* [Library](/reference_guide/project_model/library.md)

* [Facet](/reference_guide/project_model/facet.html)
* [Facet](/reference_guide/project_model/facet.md)


2 changes: 1 addition & 1 deletion reference_guide/project_wizard.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ which has two methods to be overridden:

Facets in IntelliJ are the way to store multiple kinds of module-specific settings, for instance to make a language support or framework available in some given module.
To understand facets better from the point of view of an end-user, please see
[Facet](/reference_guide/project_model/facet.html)
[Facet](/reference_guide/project_model/facet.md)
documentation section.


Expand Down
22 changes: 11 additions & 11 deletions tutorials.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@ title: Tutorials
This section contains a set of step-by-step tutorials which some aspects of work with *IntelliJ Platform*.

To set up development environment and get started please refer to the
[Basics](basics.html) section.
[Basics](basics.md) section.

More detailed explanation of the API components can be found in the
[Architecture Reference Guide](reference_guide.html).
[Architecture Reference Guide](reference_guide.md).


**List of Tutorials:**

* [Custom Language Support](tutorials/custom_language_support_tutorial.html)
* [Writing Tests For Plugins](tutorials/writing_tests_for_plugins.html)
* [Action System](tutorials/action_system.html)
* [Editor Basics](tutorials/editor_basics.html)
* [Project Wizard](tutorials/project_wizard.html)
* [Code Inspections](tutorials/code_inspections.html)
* [Run Configurations](tutorials/run_configurations.html)
* [Supporting Frameworks](tutorials/framework.html)
* [Tree Structure View](tutorials/tree_structure_view.html)
* [Custom Language Support](tutorials/custom_language_support_tutorial.md)
* [Writing Tests For Plugins](tutorials/writing_tests_for_plugins.md)
* [Action System](tutorials/action_system.md)
* [Editor Basics](tutorials/editor_basics.md)
* [Project Wizard](tutorials/project_wizard.md)
* [Code Inspections](tutorials/code_inspections.md)
* [Run Configurations](tutorials/run_configurations.md)
* [Supporting Frameworks](tutorials/framework.md)
* [Tree Structure View](tutorials/tree_structure_view.md)
4 changes: 2 additions & 2 deletions tutorials/action_system.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Action can either be simply a response to some state, or be bound to UI element
These UI elements include main menu, context menus, and toolbars.


* [Working With Custom Actions](action_system/working_with_custom_actions.html)
* [Grouping Action](action_system/grouping_action.html)
* [Working With Custom Actions](action_system/working_with_custom_actions.md)
* [Grouping Action](action_system/grouping_action.md)


[Plugin source code](https://github.com/JetBrains/intellij-sdk-docs/tree/master/code_samples/register_actions)
Expand Down
Loading

0 comments on commit 7b75f3a

Please sign in to comment.