diff --git a/topics/intro/sdk_style.md b/topics/intro/sdk_style.md index dfb8a3d0d..c0c1caa9b 100644 --- a/topics/intro/sdk_style.md +++ b/topics/intro/sdk_style.md @@ -1,6 +1,6 @@ -# SDK Docs Style Guide + - +# SDK Docs Style Guide Writing and notation styleguide for SDK Docs. @@ -59,7 +59,7 @@ The page title should be as concise as possible, so it can be reused in the [](# Every page **should** provide a short excerpt (usually one sentence) using dedicated `` tag before the main page contents: ```html -Listeners allow subscription to application and project events. +Defining groups of related settings. ``` #### Highlighted Links @@ -110,7 +110,7 @@ Consistent text styles are used to standardize references and keywords: * File formats are shown as all capital letters: PNG and XML. * Filename extensions are not capitalized when part of a full filename, path, or URL: plugin.xml. * Keyboard shortcuts are wrapped using ``: `press Alt+Insert` becomes "press Alt+Insert". -* See [Guidelines for Highlighting Syntax](#guidelines-for-highlighting-syntax) for more best practices for representing code fragments. +* See [Guidelines for Highlighting Syntax](#guidelines-for-highlighting-syntax) for best practices for representing code fragments. * See [Links to IntelliJ Platform Source](#links-to-intellij-platform-source) for more details about representing names of source files in links. ### Links @@ -127,6 +127,7 @@ In some cases (e.g., the same heading text appears multiple times on the same pa ### Properties {#task1-properties} [...] + ## Task 2 ### Properties {#task2-properties} @@ -194,7 +195,7 @@ Syntax highlighting is applied by specifying the language after the first set of ``` ```xml - XML Text + XML Text ``` ``` @@ -345,6 +346,6 @@ Specify the previous path(s) including .html extension in `accepts- ```xml + id="themes_getting_started.md" + accepts-web-file-names="themes.html,themes-intro.html"/> ```