Writerside
jetbrains.com
- Free plan
- Windows
- macOS
- Linux
- Browser extension
What Writerside is
Writerside is used to author, build, test, and publish technical documentation. It is now available as a plugin for JetBrains IDEs rather than as a standalone IDE. The plugin retains the standalone version's features and adds editor support and validation for supported code samples. It includes an authoring plugin, a documentation builder, and a frontend for rendering help websites. Writerside supports Markdown and semantic markup, and lets teams reuse 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. Its Docker builder can be used in CI/CD pipelines, and it can generate PDFs with a table of contents and optional cover, header, and footer. It can also generate API entity references from OpenAPI specifications. Local previews have built-in search, while published documentation uses an external search service by default. AI writing actions such as rephrasing and translation require the Grazie Pro plugin. The free plugin is available through JetBrains IDEs for Linux, macOS, and Windows.
Who it suits
Writerside suits technical writers and development teams creating documentation with JetBrains IDEs. Its Git, Docker, and OpenAPI support may fit teams automating documentation builds and publishing.
Good to know, and what to watch
- Supports Markdown and semantic markup.
- Reuses documentation topics and other content elements.
- Automates builds, testing, and deployment with Git integration.
- Generates PDFs and OpenAPI-based API references.
- Free plugin retains standalone-version functionality.
- No longer available as a standalone IDE.
- Published documentation uses an external search service by default.
- AI writing actions require the Grazie Pro plugin.
- Rider and DataGrip cannot create new Writerside projects.
Plans
Every plan and priceFree plugin
Free plan
Getting started
- Open the Writerside website
- Install the free plugin in a JetBrains IDE
- Create or open a Writerside documentation project
- Author content with Markdown or semantic markup
- Connect GitHub or GitLab for builds and deployment
- Use the Docker builder for CI/CD when needed
- Publish through the rendered documentation frontend
Limits to check
The plugin is free, but AI writing actions require the Grazie Pro plugin. Published documentation relies on an external search service by default, and Rider and DataGrip have a known issue preventing creation of new Writerside projects.
The verdict
Writerside combines documentation authoring, builds, and publishing in a JetBrains IDE plugin. It offers reuse and automation tools, but published-site search relies on an external service by default.
Questions people ask
How much does Writerside cost?
The Free plugin plan costs nothing and includes all standalone-version functionality.
Which operating systems are supported?
Writerside supports Linux, macOS, and Windows through JetBrains IDEs.
Is Writerside a standalone IDE?
No. It is available as a plugin for JetBrains IDEs; the standalone IDE is no longer available.
Can Writerside generate PDFs and API references?
Yes. It can generate PDFs and create API entity references from OpenAPI specifications.
Does it include search?
Local previews have built-in search. Published documentation uses an external search service by default.
What is needed for AI writing actions?
Actions such as rephrasing, review, translation, and summaries require the Grazie Pro plugin.
What the maker publishes
- AI writing
- AI writing actions such as rephrasing, review, translation, and summaries require the Grazie Pro plugin. source
- API documentation
- Writerside can generate API entity references from OpenAPI specifications. source
- CI builds
- The Writerside Docker builder can be used for automated builds and CI/CD pipelines, with instructions for GitHub, GitLab, and TeamCity. source
- Components
- The plugin includes an authoring IDE plugin, a documentation builder, and a frontend for rendering help websites. source
- Content reuse
- Writerside supports single sourcing and reusing topics, sections, markup elements, filters, and variables across documentation outputs. source
- Feature parity
- The plugin has the same features as the standalone version and adds editor support and validation for supported code samples. source
- Known limitation
- Rider and DataGrip have a known issue that prevents creating a new Writerside project, although existing projects can be edited. source
- Markup
- Writerside supports Markdown and semantic markup. source
- PDF export
- Writerside can generate PDFs with a table of contents and optional cover, header, and footer content. source
- Product format
- Writerside is available as a plugin for JetBrains IDEs and is no longer available as a standalone IDE. source
- Purpose
- Writerside is used to author, build, test, and publish technical documentation. source
- Search limitation
- Local preview has built-in search, while published documentation requires an external search service by default. source
- 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. source
- Support
- JetBrains directs Writerside users to its Slack community for feedback and support. source
- Version control
- Writerside has built-in Git integration and can automate builds, testing, and deployment with GitHub or GitLab hosting. source
Checked against the maker's pages on 30 Sept 2026.