Add link-summary elements

This commit is contained in:
Karol Lewandowski 2022-12-07 16:50:02 +01:00
parent ba9435b4c9
commit c3ae8e87b1
7 changed files with 25 additions and 11 deletions

View File

@ -1,7 +1,9 @@
[//]: # (title: Virtual Files) # Virtual Files
<!-- Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. --> <!-- Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<link-summary>Virtual Files represent local or remote files provided by the Virtual File System.</link-summary>
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). 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. Most commonly, a virtual file is a file in a local file system.

View File

@ -1,7 +1,9 @@
[//]: # (title: Publishing a Plugin) # Publishing a Plugin
<!-- Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. --> <!-- Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<link-summary>Publishing a plugin to JetBrains Marketplace manually or with Gradle IntelliJ Plugin.</link-summary>
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. 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). The first plugin publication, even when a project uses the Gradle setup, must be [uploaded manually](#uploading-a-plugin-to-jetbrains-marketplace).

View File

@ -1,6 +1,8 @@
[//]: # (title: Persisting State of Components) # Persisting State of Components
<!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. --> <!-- Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<link-summary>Persisting data that is available after IDE restarts and can be shared between different IDE installations.</link-summary>
The IntelliJ Platform provides an API that allows components or services to persist their state between restarts of the IDE. 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. 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.

View File

@ -1,6 +1,8 @@
[//]: # (title: Virtual File System) # Virtual File System
<!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. --> <!-- Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<link-summary>Virtual File System is an abstraction that allows to work with local or remote file storages and implement custom.</link-summary>
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). 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).

View File

@ -1,6 +1,8 @@
[//]: # (title: Syntax and Error Highlighting) # Syntax and Error Highlighting
<!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. --> <!-- Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<link-summary>Highlighting syntax and semantic code errors on multiple levels.</link-summary>
<tldr> <tldr>

View File

@ -1,6 +1,8 @@
[//]: # (title: Working with Icons and Images) # Working with Icons and Images
<!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. --> <!-- Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<link-summary>Adding, organizing, and working with IntelliJ Platform and custom icons and images.</link-summary>
<tldr> <tldr>

View File

@ -1,7 +1,9 @@
[//]: # (title: Configuring Gradle IntelliJ Plugin) # Configuring Gradle IntelliJ Plugin
<!-- Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. --> <!-- Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<link-summary>Configuring the essential Gradle IntelliJ Plugin attributes and tasks.</link-summary>
This section presents a guided tour of Gradle plugin attributes to achieve the commonly desired functionality. 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. For more advanced options, see the full [Gradle IntelliJ Plugin](tools_gradle_intellij_plugin.md) reference.