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

Writerside: update references

Browse Source
This commit is contained in:
Yann Cébron 2025-03-11 14:01:45 +01:00
parent c7406a6b4f
commit ba2d5383f6
4 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
topics/appendix/resources/useful_links.md
View File

@ -1,4 +1,4 @@
<!-- Copyright 2000-2024 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-2025 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. -->
# Useful Links
@ -8,7 +8,7 @@ The following links represent useful resources for working with the IntelliJ Pla
### Tooling
> Use [Writerside](https://www.jetbrains.com/writerside/) to create and publish documentation for your plugin.
> Use [Writerside](https://plugins.jetbrains.com/plugin/20158-writerside) to create and publish documentation for your plugin.
>
{style="note"}

3
topics/intro/intellij_platform.md
View File

@ -1,4 +1,4 @@
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<!-- Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# The IntelliJ Platform
@ -79,7 +79,6 @@ The following IDEs are based on the IntelliJ Platform:
* [RubyMine](rubymine.md)
* [RustRover](https://www.jetbrains.com/rust/)
* [WebStorm](webstorm.md)
* [Writerside](https://www.jetbrains.com/writerside/)
* [Android Studio](android_studio.md) IDE from Google
* [Comma](https://commaide.com/) IDE for Raku (formerly known as Perl 6)
* [Jmix Studio](https://www.jmix.io/tools/)

2
topics/intro/sdk_style.md
View File

@ -18,7 +18,7 @@ To verify grammar and correct spelling, it is highly recommended to use [Grazie
## Documentation Markup
The documentation project is using [Writerside](https://www.jetbrains.com/writerside), so the plugin should be installed to have full support in the IDE.
The documentation project is using [Writerside](https://plugins.jetbrains.com/plugin/20158-writerside), so the plugin should be installed to have full support in the IDE.
The topic files themselves are [Markdown](https://github.github.com/gfm/) files (<path>*.md</path>) using some Writerside-specific custom tags (see below).
### Page Format

6
topics/ui/resources/how_to_write_guidelines.topic
View File

@ -4,7 +4,7 @@
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
id="how_to_write_guidelines" title="How to Write Guidelines">
<!-- Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<!-- Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<title>
How to Write Guidelines
</title>
@ -306,7 +306,7 @@
<chapter title="Tips and notes" id="tips-and-notes">
<p>Use tips <code>&lt;tip&gt;&lt;/tip&gt;</code> to add links to additional materials, sources, useful
facts, and examples:</p>
<tip>Find more examples in <a href="https://www.jetbrains.com/help/writerside/admonitions.html#tip">Writerside
<tip>Find more examples in <a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/admonitions.html">Writerside
documentation</a>.
</tip>
<p>Use notes <code>&lt;note&gt;&lt;/note&gt;</code> to highlight important information like
@ -420,7 +420,7 @@
<p>Provide code snippets along the article to help developers implement the described look and behavior.</p>
<p>If a code snippet is too big, put it at the end of the article and provide a link.</p>
<p>To insert a snippet, use <code>&lt;code-block&gt;&lt;/code-block&gt;</code>. Read more in <a
href="https://www.jetbrains.com/help/writerside/code.html">Writerside documentation</a>.</p>
href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/">Writerside documentation</a>.</p>
</chapter>
</topic>