Znai is a documentation generator designed for creating technical user guides, tutorials and reference material from Markdown. It is particularly useful for software projects where documentation needs to remain closely connected to source code, tests and other development artefacts.
The software goes beyond conventional Markdown publishing by allowing documentation to incorporate material extracted from external resources. This reduces duplication and helps technical authors keep examples and explanations consistent with the software being documented. Generated documentation can be published as a standalone website or organised alongside other guides.
This is free and open source software.
Key Features
- Extends Markdown with plugins for embedding source code, function bodies, API references and other externally maintained content.
- Integrates with Java, Python, C++ and OpenAPI documentation, allowing technical references to be assembled from project resources.
- Supports charts, flow diagrams, cards, annotated images and REST responses, including material produced by automated tests.
- Provides a live preview mode that watches local files, navigates to affected pages and highlights changes as documentation is edited.
- Includes instant page navigation and local search with result previews for finding information within large documentation sets.
- Offers two-column page layouts with language switching for examples, together with runtime light and dark themes.
- Converts documentation into presentation slides without requiring a separately maintained presentation source.
- Provides a self-hosted documentation hub for bringing multiple guides together under a common entry point.
Website: github.com/testingisdocumenting/znai
Support:
Developer: Testing Is Documenting
License: Apache License 2.0
Znai is written in Java and JavaScript. Learn Java with our recommended free books and free tutorials. Learn JavaScript with our recommended free books and free tutorials.
Related Software
| Java Static Site Generators | |
|---|---|
| JBake | Static site/blog generator for developers and designers |
| Znai | Build functional, maintainable, beautiful user guides |
| Roq | Aims to provide a modern approach with Quarkus at its core |
| CoWeM | Static site generator for course websites |
| Igapyonv3 | Lightweight and turnkey static site/blog generator |
Read our verdict in the software roundup.
 LinuxLinks helps you discover the best free and open source software for Linux. Explore our extensive collection of recommended applications, including alternatives to popular proprietary software.We also publish software reviews, Linux tutorials, hardware reviews, free programming books and articles covering the wider open source community. Browse our Linux resources to discover more. Know a useful free and open source Linux application we haven't covered? Suggest a program for inclusion. Has your software been featured on LinuxLinks? Display one of our Featured on LinuxLinks badges on your website or GitHub README. |
Please read our Comment Policy before commenting.