diff --git a/topics/appendix/plugin_repository_obsolete.md b/topics/appendix/plugin_repository_obsolete.md index f5c507579..28126e32c 100644 --- a/topics/appendix/plugin_repository_obsolete.md +++ b/topics/appendix/plugin_repository_obsolete.md @@ -1,6 +1,8 @@ -[//]: # (title: JetBrains Marketplace) + - +# JetBrains Marketplace + +Overview of key JetBrains Marketplace Documentation topics. JetBrains provides an official plugin repository [JetBrains Marketplace](https://plugins.jetbrains.com) for all IntelliJ Platform-based IDEs, as well as other products. diff --git a/topics/appendix/resources/consulting.md b/topics/appendix/resources/consulting.md index 6708a16e0..b2c92d76b 100644 --- a/topics/appendix/resources/consulting.md +++ b/topics/appendix/resources/consulting.md @@ -1,6 +1,8 @@ + + # Consulting - +List of independent companies and individuals providing paid plugin consulting and development services. The following independent companies and individuals provide paid plugin consulting and development services. @@ -8,17 +10,17 @@ Also, consider posting requests in _#jobs_ channel on [JetBrains Platform Slack] > JetBrains is not responsible for nor guarantees the performance of these independent third-party companies. -| Name | Contact | Notes | -|--------------------|---------------------------------------------------------|---------------------------------------------| -| Joachim Ansorg | [www.plugin-dev.com][ja] | -/- | -| Daniel Espendiller | [daniel@espendiller.net][de] | -/- | -| Robert Ekendahl | [www.edaphic.studio][re] | Custom Language support | -| Alexey Stukalov | [info@jpa-buddy.com][ast], [www.haulmont.com][ast2] | Plugins: [CUBA][ast3], [JPA Buddy][ast4], [React Buddy][ast5], [Jmix][ast6].| -| Edument | [jonathan@edument.cz][ed], [edument.se][ed2] | Developers of [Comma IDE][ed3] | -| Mikhail Bolotov | [mikhail.bolotov@gmail.com][mb] | Plugins: [Cypress Support Pro][cspro], [k6] | -| Ilscipio GmbH | [Paul Piper][il], [www.ilscipio.com][il2] | Custom Plugin Development | -| Tamás Balog | [www.picimako.com][pm] | Custom Plugin Development | -| Jacky Liu | [beansoft@126.com][bn], [Marketplace of BeanSoft][bn2] | Custom Plugin Development, Plugins: [React Native Console][rnc] | +| Name | Contact | Notes | +|--------------------|---------------------------------------------------------|------------------------------------------------------------------------------| +| Joachim Ansorg | [www.plugin-dev.com][ja] | -/- | +| Daniel Espendiller | [daniel@espendiller.net][de] | -/- | +| Robert Ekendahl | [www.edaphic.studio][re] | Custom Language support | +| Alexey Stukalov | [info@jpa-buddy.com][ast], [www.haulmont.com][ast2] | Plugins: [CUBA][ast3], [JPA Buddy][ast4], [React Buddy][ast5], [Jmix][ast6]. | +| Edument | [jonathan@edument.cz][ed], [edument.se][ed2] | Developers of [Comma IDE][ed3] | +| Mikhail Bolotov | [mikhail.bolotov@gmail.com][mb] | Plugins: [Cypress Support Pro][cspro], [k6] | +| Ilscipio GmbH | [Paul Piper][il], [www.ilscipio.com][il2] | Custom Plugin Development | +| Tamás Balog | [www.picimako.com][pm] | Custom Plugin Development | +| Jacky Liu | [beansoft@126.com][bn], [Marketplace of BeanSoft][bn2] | Custom Plugin Development, Plugins: [React Native Console][rnc] | [ja]: https://www.plugin-dev.com [de]: mailto:daniel@espendiller.net diff --git a/topics/basics/analyzing.md b/topics/basics/analyzing.md index fae441b80..cd3623a13 100644 --- a/topics/basics/analyzing.md +++ b/topics/basics/analyzing.md @@ -2,6 +2,8 @@ # Analyzing +The Analyzing section overview. + * [](syntax_errors.md) * Annotator * [Inspections](code_inspections.md) diff --git a/topics/basics/architectural_overview/files.md b/topics/basics/architectural_overview/files.md index dd4678899..aebf48e0f 100644 --- a/topics/basics/architectural_overview/files.md +++ b/topics/basics/architectural_overview/files.md @@ -1,6 +1,8 @@ -[//]: # (title: Files) + - +# Files + +The Files section overview. * [Virtual File System](virtual_file_system.md) -* [Virtual Files](virtual_file.md) \ No newline at end of file +* [Virtual Files](virtual_file.md) diff --git a/topics/basics/architectural_overview/modifying_psi.md b/topics/basics/architectural_overview/modifying_psi.md index 9fc281191..4943daea8 100644 --- a/topics/basics/architectural_overview/modifying_psi.md +++ b/topics/basics/architectural_overview/modifying_psi.md @@ -2,6 +2,8 @@ # Modifying the PSI +Creating, deleting, and modifying PSI elements. + The PSI is a read/write representation of the source code as a tree of elements corresponding to a source file's structure. You can modify the PSI by *adding*, *replacing*, and *deleting* PSI elements. diff --git a/topics/basics/editing.md b/topics/basics/editing.md index 42c9968a5..4c20405c5 100644 --- a/topics/basics/editing.md +++ b/topics/basics/editing.md @@ -1,6 +1,8 @@ -[//]: # (title: Editing) + - +# Editing + +The Editing section overview. * Code Completion * [](postfix_completion.md) diff --git a/topics/basics/plugin_structure/plugin_actions.md b/topics/basics/plugin_structure/plugin_actions.md index 390058454..39a9dc1b5 100644 --- a/topics/basics/plugin_structure/plugin_actions.md +++ b/topics/basics/plugin_structure/plugin_actions.md @@ -1,6 +1,8 @@ -[//]: # (title: Actions) + - +# Actions + +Introduction to actions allowing to invoke plugin functionalities. The IntelliJ Platform provides the concept of _actions_. An action is a class derived from [`AnAction`](%gh-ic%/platform/editor-ui-api/src/com/intellij/openapi/actionSystem/AnAction.java), whose `actionPerformed()` method is called when its menu item or toolbar button is selected. diff --git a/topics/basics/plugin_user_experience.md b/topics/basics/plugin_user_experience.md index 6db020d2d..12a903659 100644 --- a/topics/basics/plugin_user_experience.md +++ b/topics/basics/plugin_user_experience.md @@ -1,7 +1,7 @@ -# Plugin User Experience (UX) - +# Plugin User Experience (UX) + Ensuring a good user experience for your plugin. _User Experience (UX)_ is a term describing the experience users feel when using a product. diff --git a/topics/basics/project_view.md b/topics/basics/project_view.md index 57b5709fe..1bd4472a2 100644 --- a/topics/basics/project_view.md +++ b/topics/basics/project_view.md @@ -1,6 +1,8 @@ -[//]: # (title: Project View) + - +# Project View + +Changing the project view nodes representation. diff --git a/topics/intro/sdk_code_guidelines.md b/topics/intro/sdk_code_guidelines.md index 7fa157758..be215a852 100644 --- a/topics/intro/sdk_code_guidelines.md +++ b/topics/intro/sdk_code_guidelines.md @@ -1,6 +1,8 @@ + + # SDK Code Sample Guidelines - +Coding guidelines for the code contributed to the IntelliJ SDK Code Samples. This document describes the coding guidelines used for authoring open-source IntelliJ Platform SDK code samples. Before you begin, please read this page thoroughly, as well as the [Code of Conduct](intellij-sdk-docs-original_CODE_OF_CONDUCT.md) and [License](https://github.com/JetBrains/intellij-sdk-docs/blob/main/LICENSE.txt) documents. diff --git a/topics/products/idea/idea_ultimate.md b/topics/products/idea/idea_ultimate.md index 186b9c53d..82b0552b4 100644 --- a/topics/products/idea/idea_ultimate.md +++ b/topics/products/idea/idea_ultimate.md @@ -1,6 +1,8 @@ + + # IntelliJ IDEA Ultimate - +The IntelliJ IDEA Ultimate section overview. diff --git a/topics/products/phpstorm/php_open_api_php_type_providers.md b/topics/products/phpstorm/php_open_api_php_type_providers.md index bbcfcd198..ca1be6451 100644 --- a/topics/products/phpstorm/php_open_api_php_type_providers.md +++ b/topics/products/phpstorm/php_open_api_php_type_providers.md @@ -1,6 +1,8 @@ -[//]: # (title: PHP Type Providers) + - +# PHP Type Providers + +Providing element type information for PHP type inference mechanism. Type inference in PhpStorm is built on top of type providers, each of which is responsible for inferring the types of specific PSI elements. @@ -13,7 +15,7 @@ All providers inherit from `com.jetbrains.php.lang.psi.resolve.types.PhpTypeProv The first phase of type inference takes place at the indexing stage. At this phase, PhpStorm calls `PhpTypeProvider4.getType()` on each type provider. -PhpStorm only has access to local information from the current file and can't use information from other files as well as indexes because it does't yet build them. +PhpStorm only has access to local information from the current file and can't use information from other files as well as indexes because it doesn't yet build them. Sometimes, it can deduce the exact type from this information, but in other cases this is impossible because PhpStorm requires information from other files. Because of this, there are two kinds of types in PhpStorm: @@ -21,7 +23,7 @@ Because of this, there are two kinds of types in PhpStorm: - Complete types - Incomplete types -### Complete types +### Complete Types Complete types are types that are known exactly based on **only** the local information of the current file. @@ -43,7 +45,7 @@ function foo(string $a): string { Here, since the `$a` parameter has a `string` type hint, PhpStorm can infer the Complete type `string`. -### Incomplete types +### Incomplete Types Incomplete types are types that need additional information from other project files besides the containing file. diff --git a/topics/reference_guide/editors.md b/topics/reference_guide/editors.md index e77c3fe2c..efcb6843c 100644 --- a/topics/reference_guide/editors.md +++ b/topics/reference_guide/editors.md @@ -1,6 +1,8 @@ -[//]: # (title: Editors) + - +# Editors + +The Editors section overview. This section covers working with text in the IntelliJ Platform editor. It is presented in two major sections: @@ -10,4 +12,4 @@ It is presented in two major sections: * Handling actions activated by keystroke events in the editor. * [Multiple carets](multiple_carets.md) * Working with multiple, independent, carets in one editor. - * How multiple carets affect core functionality, editor actions, typing actions, and code insight actions. \ No newline at end of file + * How multiple carets affect core functionality, editor actions, typing actions, and code insight actions. diff --git a/topics/reference_guide/project_model/build_system.md b/topics/reference_guide/project_model/build_system.md index 7a6f1b4d8..93427e9cf 100644 --- a/topics/reference_guide/project_model/build_system.md +++ b/topics/reference_guide/project_model/build_system.md @@ -1,5 +1,7 @@ -[//]: # (title: Build System) + - +# Build System -* [External builder API and plugins](external_builder_api.md) \ No newline at end of file +The Analyzing section overview. + +* [External builder API and plugins](external_builder_api.md) diff --git a/topics/reference_guide/project_model/trusted_projects.md b/topics/reference_guide/project_model/trusted_projects.md index 52f2ec461..8290f7841 100644 --- a/topics/reference_guide/project_model/trusted_projects.md +++ b/topics/reference_guide/project_model/trusted_projects.md @@ -1,6 +1,8 @@ -[//]: # (title: Trusted Project) + - +# Trusted Project + +Preventing executing malicious code in untrusted projects. diff --git a/topics/reference_guide/project_wizard.md b/topics/reference_guide/project_wizard.md index 1e90febee..6e4fe17c0 100644 --- a/topics/reference_guide/project_wizard.md +++ b/topics/reference_guide/project_wizard.md @@ -1,6 +1,8 @@ -[//]: # (title: Project Wizard - Adding Support for Creating New Project Types) + - +# Project Wizard - Adding Support for Creating New Project Types + +Implementing a custom project creation wizard. ## Project Wizard diff --git a/topics/reference_guide/text_selection.md b/topics/reference_guide/text_selection.md index b836a249e..a53d2588e 100644 --- a/topics/reference_guide/text_selection.md +++ b/topics/reference_guide/text_selection.md @@ -1,6 +1,8 @@ -[//]: # (title: Text Selection) + - +# Text Selection + +Providing additional text ranges used when a text selection is extended/shrank. ## Extending/Shrinking Text Selection diff --git a/topics/tutorials/framework.md b/topics/tutorials/framework.md index 1b5c9b69c..37a5d05c6 100644 --- a/topics/tutorials/framework.md +++ b/topics/tutorials/framework.md @@ -1,6 +1,8 @@ -[//]: # (title: Frameworks) + - +# Frameworks + +Tutorial on implementing custom framework types. The following tutorial shows how to support a custom framework type for a project and make this framework type embedded in a project wizard as a UI component. The examples in this tutorial rely heavily on the [framework_basics](%gh-sdk-samples%/framework_basics) code sample. diff --git a/topics/tutorials/intro_project_wizard.md b/topics/tutorials/intro_project_wizard.md index cc0748c2a..cc8e3dca8 100644 --- a/topics/tutorials/intro_project_wizard.md +++ b/topics/tutorials/intro_project_wizard.md @@ -1,6 +1,8 @@ -[//]: # (title: Project Wizard Tutorial) + - +# Project Wizard Tutorial + +The Project Wizard Tutorial section overview. This set of tutorials shows how to manipulate the process of project creation. Configuring Project Wizard automatically allows you to do the following: