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

sdk_style.md: Remove information about unused [//] # (title: ...) notation

Browse Source
This commit is contained in:
Karol Lewandowski 2023-04-07 15:50:05 +02:00
parent 95aca84917
commit f4f3d07989
1 changed files with 1 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
topics/intro/sdk_style.md
View File

@ -29,29 +29,12 @@ Each Markdown file **must** start with a copyright notice, formatted using HTML
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
```
It **must** be followed by a header defining its title using the following notation:
<tabs>
<tab title="New Format">
Define Level 1 heading:
It **must** be followed by a header defining its title using the level 1 heading:
```
# Contributing to the IntelliJ Platform SDK
```
</tab>
<tab title="Legacy Format">
Legacy notation, should be converted to New Format when editing a page:
```yaml
[//]: # (title: Contributing to the IntelliJ Platform SDK)
```
</tab>
</tabs>
The page title should be as concise as possible, so it can be reused in the [](#table-of-contents) as is.
#### Excerpt