From c3ae8e87b11e390f89fbdab5149cf99c4ae8542a Mon Sep 17 00:00:00 2001 From: Karol Lewandowski Date: Wed, 7 Dec 2022 16:50:02 +0100 Subject: [PATCH] Add link-summary elements --- topics/basics/architectural_overview/virtual_file.md | 4 +++- topics/basics/getting_started/publishing_plugin.md | 4 +++- topics/basics/persisting_state_of_components.md | 6 ++++-- topics/basics/virtual_file_system.md | 6 ++++-- .../syntax_highlighting_and_error_highlighting.md | 6 ++++-- topics/reference_guide/work_with_icons_and_images.md | 6 ++++-- topics/tutorials/build_system/configuring_plugin_project.md | 4 +++- 7 files changed, 25 insertions(+), 11 deletions(-) diff --git a/topics/basics/architectural_overview/virtual_file.md b/topics/basics/architectural_overview/virtual_file.md index ea5eeb999..640511bc8 100644 --- a/topics/basics/architectural_overview/virtual_file.md +++ b/topics/basics/architectural_overview/virtual_file.md @@ -1,7 +1,9 @@ -[//]: # (title: Virtual Files) +# Virtual Files +Virtual Files represent local or remote files provided by the Virtual File System. + A [`VirtualFile`](%gh-ic%/platform/core-api/src/com/intellij/openapi/vfs/VirtualFile.java) (VF) is the IntelliJ Platform's representation of a file in a [Virtual File System (VFS)](virtual_file_system.md). Most commonly, a virtual file is a file in a local file system. diff --git a/topics/basics/getting_started/publishing_plugin.md b/topics/basics/getting_started/publishing_plugin.md index 0ff1bc27e..398dc8a5b 100644 --- a/topics/basics/getting_started/publishing_plugin.md +++ b/topics/basics/getting_started/publishing_plugin.md @@ -1,7 +1,9 @@ -[//]: # (title: Publishing a Plugin) +# Publishing a Plugin +Publishing a plugin to JetBrains Marketplace manually or with Gradle IntelliJ Plugin. + When your plugin is ready, you can publish it to a [JetBrains Marketplace](https://plugins.jetbrains.com) plugin repository so that other users can install it in IDE. The first plugin publication, even when a project uses the Gradle setup, must be [uploaded manually](#uploading-a-plugin-to-jetbrains-marketplace). diff --git a/topics/basics/persisting_state_of_components.md b/topics/basics/persisting_state_of_components.md index 09d0ed9d2..4d8b334b6 100644 --- a/topics/basics/persisting_state_of_components.md +++ b/topics/basics/persisting_state_of_components.md @@ -1,6 +1,8 @@ -[//]: # (title: Persisting State of Components) +# Persisting State of Components - + + +Persisting data that is available after IDE restarts and can be shared between different IDE installations. The IntelliJ Platform provides an API that allows components or services to persist their state between restarts of the IDE. You can use either a simple API to persist a few values or persist the state of more complicated components using the [`PersistentStateComponent`](%gh-ic%/platform/projectModel-api/src/com/intellij/openapi/components/PersistentStateComponent.java) interface. diff --git a/topics/basics/virtual_file_system.md b/topics/basics/virtual_file_system.md index fa16bfbaf..cd9309ef2 100644 --- a/topics/basics/virtual_file_system.md +++ b/topics/basics/virtual_file_system.md @@ -1,6 +1,8 @@ -[//]: # (title: Virtual File System) +# Virtual File System - + + +Virtual File System is an abstraction that allows to work with local or remote file storages and implement custom. The Virtual File System (VFS) is a component of the IntelliJ Platform that encapsulates most of its activity for working with files represented as [Virtual File](virtual_file.md). diff --git a/topics/reference_guide/custom_language_support/syntax_highlighting_and_error_highlighting.md b/topics/reference_guide/custom_language_support/syntax_highlighting_and_error_highlighting.md index 2751e461a..09adbf043 100644 --- a/topics/reference_guide/custom_language_support/syntax_highlighting_and_error_highlighting.md +++ b/topics/reference_guide/custom_language_support/syntax_highlighting_and_error_highlighting.md @@ -1,6 +1,8 @@ -[//]: # (title: Syntax and Error Highlighting) +# Syntax and Error Highlighting - + + +Highlighting syntax and semantic code errors on multiple levels. diff --git a/topics/reference_guide/work_with_icons_and_images.md b/topics/reference_guide/work_with_icons_and_images.md index 2ddae054c..023f2c386 100644 --- a/topics/reference_guide/work_with_icons_and_images.md +++ b/topics/reference_guide/work_with_icons_and_images.md @@ -1,6 +1,8 @@ -[//]: # (title: Working with Icons and Images) +# Working with Icons and Images - + + +Adding, organizing, and working with IntelliJ Platform and custom icons and images. diff --git a/topics/tutorials/build_system/configuring_plugin_project.md b/topics/tutorials/build_system/configuring_plugin_project.md index c7e01e28f..2d67db08c 100644 --- a/topics/tutorials/build_system/configuring_plugin_project.md +++ b/topics/tutorials/build_system/configuring_plugin_project.md @@ -1,7 +1,9 @@ -[//]: # (title: Configuring Gradle IntelliJ Plugin) +# Configuring Gradle IntelliJ Plugin +Configuring the essential Gradle IntelliJ Plugin attributes and tasks. + This section presents a guided tour of Gradle plugin attributes to achieve the commonly desired functionality. For more advanced options, see the full [Gradle IntelliJ Plugin](tools_gradle_intellij_plugin.md) reference.