hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-30 18:27:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

sdk_style.md: add information about internal docs links

Browse Source
This commit is contained in:
Karol Lewandowski 2022-05-24 14:15:13 +02:00
parent e16176cfd9
commit 396ebb0bbd
1 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
topics/intro/sdk_style.md
View File

@ -77,14 +77,18 @@ For example, `## Introduction` gets the ID of `introduction`, and can be linked
General Markdown links have the default Markdown link style:
* `[Gradle](https://gradle.org)`{disable-links} ([Gradle](https://gradle.org)) links to an external site, such as companies, articles, etc.
If URL contains `%` character, append `{interpolate-variables="false"}`.
* Linking to pages within the SDK documentation:
`[Page Title](page.md)`{disable-links} links to an SDK doc page (all located under <path>/topics</path>).
Note that the extension is <path>.md</path>, _NOT_ <path>.html</path>.
* Linking to specific _sections_ on pages in the SDK documentation.
The anchor name will be all lower case, and spaces are replaced with `-`, e.g. `## Page setup` becomes `#page-setup`.
Once the anchor (`#`) character of the link is entered, the IDE code completion feature shows the available sections.
* `[Link to a section on the current page](#another-section)`{disable-links} links to a heading on the current page.
* `[Link to the section on another page](other_page.md#another-section)`{disable-links} links to a heading on another page.
* Linking to pages and page sections within the SDK documentation:
* `[Page Title](page.md)`{disable-links} links to an SDK doc page (all located under <path>/topics</path>).
Note that the extension is <path>.md</path>, _NOT_ <path>.html</path>.
* Specific _sections_ on pages in the SDK documentation are linked by using section anchors.
The anchor name will be all lower case, and spaces are replaced with `-`, e.g. `## Page setup` becomes `#page-setup`.
Once the anchor (`#`) character of the link is entered, the IDE code completion feature shows the available sections.
* `[Link to a section on the current page](#another-section)`{disable-links} links to a heading on the current page.
* `[Link to the section on another page](other_page.md#another-section)`{disable-links} links to a heading on another page.
If the desired link label is the same as an SDK doc page or section title, leave the label part empty, e.g., `[](test-page.md)`{disable-links} or `[](test-page.md#section-1)`{disable-links}.
The empty link label will be automatically filled with the actual page or section title.
#### Links to IntelliJ Platform Source