JetBrains launches Writerside, a tool for creating technical documentation

JetBrains has announced the early access availability of  Writerside , a JetBrains IDE based on the IntelliJ platform that allows developers to write, build, test and publish technical documentation. It can be used as a plug-in in JetBrains IDE or as a stand-alone tool.

Writerside allows developers and writers to collaborate on product documentation, API references, developer guides, tutorials, and how-tos; AI-powered spell checking and grammar correction tools support more than 25 languages, including English, German, Spanish, and Chinese.

Some of Writerside’s features include:

  • Built-in Git UI.
  • With real-time preview, documents appear exactly as readers see them, without waiting for a build.
  • Supports Markdown, XML or a combination of both. Developers can inject semantic attributes or semantic elements to enrich Markdown, and Markdown elements can be converted to XML.
  • Offers customization options for the look, including choosing dark or light mode, contrast, soft or vivid skin, and defining accent colors that fit your brand. Authors can focus on content instead of designing layouts and dealing with CSS.
  • Comes with over 100 built-in tests, allowing Writerside to automatically test for broken links, missing resources, incorrect property values, non-unique IDs, and more. Features code highlighting and verification, as well as built-in inspections.
  • Maintaining a single source of truth for a project enables developers to reuse portions of content and edit it from just one location, rather than having to update every instance when changes are made.

More details can be found in the official documentation .

Guess you like

Origin www.oschina.net/news/262124/jetbrains-writerside