Create and publish beautiful online docs with a new IntelliJ Platform plugin
Product docs, API references, tutorials, developer guides, and how-tos - all inside your favorite JetBrains IDE.
Write in Markdown or combine it with our semantic XML-based markup. Convert Markdown fragments sent in by external contributors into XML on the fly.
Our tests spot more than just broken links. Find missing resources, incorrect attribute values, non-unique IDs, and much more. Automate checks for your in-house spelling and style conventions.
Customize your documentation and adapt it to your taste or brand. Choose between contrast, soft, or vivid skins and define the accent color – all in light or dark mode.
With out-of-the box Git integration, a builder that transforms your sources into a documentation website, a library of carefully designed frontend components, and automated tests that run on any CI/CD tool, you can focus on what matters most – your content.
The preview shows the docs exactly as your readers will see them. You don’t need to run a build and wait until it finishes to check if your updates look good.
Reuse anything, from smaller content chunks to entire topics or even sections of your TOC. Stay flexible with filters and variables. Use predefined templates for complex markup elements or configure your own.
With JetBrains IDEs you can keep your code error-free. We do the same for 25+ natural languages, including English, German, Spanish, Russian, and Chinese. All have an ML-based spellchecker and a grammar error correction tool.
If you write, edit, or publish docs, you do.
Our tool will save time, effort, and headaches for documentarians from all walks of life.
Don't get bogged down when documenting features and APIs. Use the built-in templates, autocompletion, and writing assistance to create or edit docs quickly and easily.
Especially if you are the only tech writer on the team, you just need to get the docs done and publish—yesterday. With single-source content reuse you can meet even impossible deadlines.
When you start small, documentation is everybody's job. Import your existing Markdown documents and create a flexible structure that will grow with your product.
This project developed out of hundreds of customer interviews and 10+ years of working on the IntelliJ Platform documentation. These experiences gave us a long list of features to build and problems to solve. We are here to address them one by one.
Do you want to help?
Single-source publishing is a powerful must-have feature that is normally among the top three competitive advantages for any professional help authoring solution. In this post we would like to draw your attention to its pitfalls so that you are forewarned and can reuse content wisely.
One day you write some code, commit, push, and then receive a comment on the pull request: “Looks good. Oh, but you misspelled this word in a class name”. Now you have to change the pull request just because of the typo.
When you ask someone what’s wrong with your documentation, the top 3 answers will be: no one reads it, it is misleading, and it is outdated. In this post, we will discuss how to keep your documentation up to date.
We are enthusiastic about docs and we want to create the best tool for people who write them – ideally with your help. Let's connect!
Contact us at firstname.lastname@example.org, anytime.
Get updates on JetBrains tools for authoring and publishing technical documentation and enroll for the Early Access Program.