- Home
- Developer Documentation Software
- Writerside
Writerside
What it is
Writerside is a tool for authoring, building, testing, and publishing technical documentation. It is now a plugin for JetBrains IDEs rather than a standalone IDE; the plugin retains the standalone version’s features and adds editor support and validation for supported code samples. Its components include an authoring plugin, a documentation builder, and a frontend for rendering help websites. Writerside supports Markdown and semantic markup, with reuse of topics, sections, markup elements, filters, and variables across documentation outputs. Built-in Git integration can automate builds, testing, and deployment with GitHub or GitLab hosting, while the Docker builder can be used in CI/CD pipelines. It can export PDFs with a table of contents and optional cover, header, and footer, and generate API entity references from OpenAPI specifications. Local previews have built-in search; published documentation uses an external search service by default. AI writing actions require the Grazie Pro plugin. The free plugin is listed for Linux, macOS, and Windows through JetBrains IDEs.
For and against
For
- Free JetBrains IDE plugin
- Supports Markdown and semantic markup
- Automates Git-based build, test, and deployment workflows
- Exports PDFs and generates OpenAPI references
Against
- No longer available as a standalone IDE
- AI writing actions require Grazie Pro
- Published documentation needs an external search service by default
- Rider and DataGrip cannot create new Writerside projects
The verdict
Writerside combines documentation authoring with build and publishing tools in a free JetBrains IDE plugin. Its search setup and AI-writing requirements are worth checking against your workflow.
Who it suits
Writerside suits technical documentation teams that use JetBrains IDEs and want reusable content, Git workflows, or generated API references. It also fits teams publishing documentation as websites or PDFs.
Plans and prices
Free plugin
JetBrains IDE plugin · all standalone-version functionality
Read 30 Sep 2026 · jetbrains.com
On the record
- AI writing
- AI writing actions such as rephrasing, review, translation, and summaries require the Grazie Pro plugin.jetbrains.com · read 30 Sep 2026
- API documentation
- Writerside can generate API entity references from OpenAPI specifications.jetbrains.com · read 30 Sep 2026
- CI builds
- The Writerside Docker builder can be used for automated builds and CI/CD pipelines, with instructions for GitHub, GitLab, and TeamCity.jetbrains.com · read 30 Sep 2026
- Components
- The plugin includes an authoring IDE plugin, a documentation builder, and a frontend for rendering help websites.jetbrains.com · read 30 Sep 2026
- Content reuse
- Writerside supports single sourcing and reusing topics, sections, markup elements, filters, and variables across documentation outputs.jetbrains.com · read 30 Sep 2026
- Feature parity
- The plugin has the same features as the standalone version and adds editor support and validation for supported code samples.jetbrains.com · read 30 Sep 2026
- Known limitation
- Rider and DataGrip have a known issue that prevents creating a new Writerside project, although existing projects can be edited.jetbrains.com · read 30 Sep 2026
- Markup
- Writerside supports Markdown and semantic markup.jetbrains.com · read 30 Sep 2026
- PDF export
- Writerside can generate PDFs with a table of contents and optional cover, header, and footer content.jetbrains.com · read 30 Sep 2026
- Product format
- Writerside is available as a plugin for JetBrains IDEs and is no longer available as a standalone IDE.jetbrains.com · read 30 Sep 2026
- Purpose
- Writerside is used to author, build, test, and publish technical documentation.jetbrains.com · read 30 Sep 2026
- Search limitation
- Local preview has built-in search, while published documentation requires an external search service by default.jetbrains.com · read 30 Sep 2026
- Security
- JetBrains says its security controls are described in its Information & Physical Security Standards and refers users to its privacy measures for protecting personal information.jetbrains.com · read 30 Sep 2026
- Support
- JetBrains directs Writerside users to its Slack community for feedback and support.jetbrains.com · read 30 Sep 2026
- Version control
- Writerside has built-in Git integration and can automate builds, testing, and deployment with GitHub or GitLab hosting.jetbrains.com · read 30 Sep 2026
