mirror of
https://github.com/JetBrains/intellij-sdk-code-samples.git
synced 2025-07-30 02:07:50 +08:00
Writerside: update references
This commit is contained in:
parent
c7406a6b4f
commit
ba2d5383f6
@ -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
|
# Useful Links
|
||||||
|
|
||||||
@ -8,7 +8,7 @@ The following links represent useful resources for working with the IntelliJ Pla
|
|||||||
|
|
||||||
### Tooling
|
### 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"}
|
{style="note"}
|
||||||
|
|
||||||
|
@ -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
|
# The IntelliJ Platform
|
||||||
|
|
||||||
@ -79,7 +79,6 @@ The following IDEs are based on the IntelliJ Platform:
|
|||||||
* [RubyMine](rubymine.md)
|
* [RubyMine](rubymine.md)
|
||||||
* [RustRover](https://www.jetbrains.com/rust/)
|
* [RustRover](https://www.jetbrains.com/rust/)
|
||||||
* [WebStorm](webstorm.md)
|
* [WebStorm](webstorm.md)
|
||||||
* [Writerside](https://www.jetbrains.com/writerside/)
|
|
||||||
* [Android Studio](android_studio.md) IDE from Google
|
* [Android Studio](android_studio.md) IDE from Google
|
||||||
* [Comma](https://commaide.com/) IDE for Raku (formerly known as Perl 6)
|
* [Comma](https://commaide.com/) IDE for Raku (formerly known as Perl 6)
|
||||||
* [Jmix Studio](https://www.jmix.io/tools/)
|
* [Jmix Studio](https://www.jmix.io/tools/)
|
||||||
|
@ -18,7 +18,7 @@ To verify grammar and correct spelling, it is highly recommended to use [Grazie
|
|||||||
|
|
||||||
## Documentation Markup
|
## 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).
|
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
|
### Page Format
|
||||||
|
@ -4,7 +4,7 @@
|
|||||||
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
|
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
|
||||||
id="how_to_write_guidelines" title="How to Write Guidelines">
|
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>
|
<title>
|
||||||
How to Write Guidelines
|
How to Write Guidelines
|
||||||
</title>
|
</title>
|
||||||
@ -306,7 +306,7 @@
|
|||||||
<chapter title="Tips and notes" id="tips-and-notes">
|
<chapter title="Tips and notes" id="tips-and-notes">
|
||||||
<p>Use tips <code><tip></tip></code> to add links to additional materials, sources, useful
|
<p>Use tips <code><tip></tip></code> to add links to additional materials, sources, useful
|
||||||
facts, and examples:</p>
|
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>.
|
documentation</a>.
|
||||||
</tip>
|
</tip>
|
||||||
<p>Use notes <code><note></note></code> to highlight important information like
|
<p>Use notes <code><note></note></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>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>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><code-block></code-block></code>. Read more in <a
|
<p>To insert a snippet, use <code><code-block></code-block></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>
|
</chapter>
|
||||||
|
|
||||||
</topic>
|
</topic>
|
||||||
|
Loading…
x
Reference in New Issue
Block a user