3.8 KiB
This is the first topic
Add new topics
You can create empty topics, or choose a template for different types of content that contains some boilerplate structure to help you get started:
{ border-effect="line" thumbnail="true" width="321"}
Write content
%product% supports two types of markup: Markdown and XML. When you create a new help article, you can choose between two topic types, but this doesn't mean you have to stick to a single format. You can author content in Markdown and extend it with semantic attributes or inject entire XML elements.
For example, this is how you inject a procedure:
Start typing procedure and select a procedure type from the completion suggestions:
Press Tab or Enter to insert the markup.
Add interactive elements
Tabs
To add switchable content, use tabs (start typing tabs on a new line).
Collapsible blocks
Besides injecting entire XML elements, you can use attributes to configure the behavior of certain elements. For example, you can collapse a chapter that contains non-essential information like this:
Supplementary info
Content under such header will be collapsed by default, but you can modify the behavior by adding the following attribute:
default-state="expanded"
Convert selection to XML
If you need to extend an element with more functions, you can convert selected content from Markdown to semantic markup. For example, if you want to merge cells in a table, it's much easier to convert it to XML than do this in Markdown. Position the caret anywhere in the table and press Alt+Enter:
Feedback and support
Please report any issues, usability improvements, or feature requests to our YouTrack project (you will need to register).
You are welcome to join our public Slack workspace. Before you do, please read our Code of conduct. We assume that you’ve read and acknowledged it before joining.
You can also always email us at writerside@jetbrains.com.
Markup reference Reorder topics in the TOC Build and publish Configure Search