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: update attribute required for escaping % parts in URLs

Browse Source
This commit is contained in:
Yann Cébron 2023-10-02 15:36:09 +02:00
parent 9fc851aedc
commit d96f751e35
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
topics/intro/sdk_style.md
View File

@ -1,7 +1,7 @@
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# SDK Docs Style Guide
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<link-summary>Writing and notation styleguide for SDK Docs.</link-summary>
This document describes the writing style used in authoring open-source IntelliJ Platform SDK documentation.
@ -124,7 +124,7 @@ In some cases (e.g., the same heading text appears multiple times on the same pa
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"}`.
If URL contains `%` character, append `{ignore-vars="true"}`.
* Linking to pages and page sections within the SDK documentation:
* `[Page Title](page.md)`{disable-links} or `[](page.md)` (use page title as link text) links to an SDK doc page (all located under <path>/topics</path>).
Note that the extension is <path>.md</path>, _NOT_ <path>.html</path>.