This is the first topic

Last modified: 30 January 2024

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:

Create new topic options

Write content

Writerside 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:

Inject a procedure

  1. Start typing procedure and select a procedure type from the completion suggestions:

    completion suggestions for procedure

  2. 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).

![Alt Text](new_topic_options.png){ width=450 }

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:

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:

Convert table to XML

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.

See also

Writerside documentation