Contributing to the documentation

This documentation project uses Writerside. If you want to edit it, you can click the Edit page button.

Then, you will be taken to GitHub where you can edit the page. Once you are done, click Commit Changes and create a pull request. However, if possible please talk with us on discord or create a new GitHub Issue beforehand.

About Writerside

The Writerside documentation can be found at Writerside | JetBrains Marketplace.

Writerside syntax overview

Writerside syntax is based on Markdown, but with some extra features.

Display keyboard shortcuts:

results in Ctrl + \

Display menu selections:

<ui-path>File | New | CSS File</ui-path>

results in File | New | CSS File

Reference elements like headings on the same page:

[Refer to](#my-heading)

## My Heading

Reference other pages:

[Other page](Contributing-to-the-source-code.md)

To include images/gifs, put them in the images directory, possibly in a subdirectory, and use

![My Image](my-image.png)

Last modified: 04 August 2024