Writerside Help

Writerside components

When you install Writerside as a plugin, you get all the components necessary for authoring, testing, and building documentation locally. They include:

  • The IDE plugin for authoring documentation.

  • The builder that compiles documentation sources into a help website.

  • The frontend application for rendering your help website in the browser.

The latter two are also available as independent redistributable components for publishing your documentation on a production website. These are scripts for building your help instance in a CI/CD pipeline and for rendering the help instance on your readers' web browsers.

Last modified: 23 May 2024