JetBrains Marketplace Help

Documentation page

If your plugin requires more than just a landing page with a list of features, add user-facing documentation as a help instance.

Unlike Custom pages, the Documentation page is not a single page but a full-fledged help instance with a structure, table of contents, in-topic navigation, and the ability to set up a search feature like the one you're reading right now. You can see some more examples here: Grazie Professional, Rust, and Edu Tools.

If you’re questioning why you should invest effort into writing documentation for your plugin, here are a few arguments for doing so:

  • Documentation makes your plugin more discoverable and searchable. When product documentation is online, external search engines will bring it to everyone who types the keywords into the search query.

  • Documentation helps you effectively communicate the features of a plugin, allowing your users to understand how it works from the start.

  • Documentation is a good way to support your current users. If they find answers in the documentation, this will decrease your support load, which is crucial for smaller teams. Good documentation also often translates to a higher rating for the plugin.

Create documentation for your plugin

To create documentation for your plugin, install the Writerside plugin for IntelliJ IDEs and start writing inside your development environment.

You can combine the simplicity of Markdown with fully structured semantic markup like collapsible chapters, code blocks, snippets with filters, tabs, and much more. On top of all that, it has a built-in live preview that displays the docs in the way they’ll appear on the web, while also offering the ability to build docs locally.

For more detailed information about the installation and documentation creation process, please refer to the Writerside plugin help.

Alternatively, you can use this quick step-by-step guide:

  1. Install the Writerside plugin.

  2. Create a documentation project alongside your plugins' code repository or in a separate docs repository.

  3. Write the content with the help of templates, live preview, and writing assistance.

  4. Build and publish the result.

Publish documentation via TeamCity Cloud

There are a few ways to build and publish your documentation with Writerside: locally, on GitHub/GitLab, or using TeamCity Cloud.

We recommend using TeamCity Cloud to build a documentation instance. TeamCity run configurations include more than 100 automated tests that run during the build to check the integrity and quality of your content, as well as a detailed build log to let you know if something goes wrong.

  1. When your content is ready for publication, build an instance locally to generate a ZIP archive.

  2. Send us your plugin's ID (for example, here is the link to Writerside plugin and, in this case, the plugin ID is 20158), a link to your public repository, and a ZIP archive name to our team via email

  3. Our team will create the TeamCity build configuration and send the link to you.

  4. You will be able to build the documentation, then publish it to staging.

  5. The documentation will appear in the Custom Pages section of the plugins' page.

    Documentation pages view

    Click Preview to see how users will see it.

  6. Go back to the TeamCity build results and promote the docs to production.

Last modified: 04 April 2024