Znai is a documentation generator for building user guides and tutorials from Markdown with an extensible plugin system.
It combines hand-written text with generated artifacts such as code snippets, API details, diagrams, charts, screenshots, and test output to help keep documentation current and easier to maintain. The software can generate static documentation sites, provides a live preview workflow while writing, and supports integrations for technologies including Python, Java, C++, and OpenAPI.
This is free and open source software.
Key Features
- Extends Markdown with plugins for code extraction, API documentation, charts, flow diagrams, cards, and annotated images.
- Provides a preview mode that watches local file changes, jumps to the affected page, and highlights updates.
- Includes local search with result previews and instant page navigation.
- Supports two-sides page layouts and runtime dark/light theme switching.
- Can turn documentation into presentation slides from the same source content.
- Available as a command-line tool and Maven plugin, with scaffolding and static site generation support.
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 |
| Orchid | Build and deploy beautiful documentation sites that grow with you |
| Roq | Aims to provide a modern approach with Quarkus at its core |
| Griffin | Very small, convenient, and extremely fast static site generator |
| Igapyonv3 | Lightweight and turnkey static site/blog generator |
| SkyDocs | Lightweight static documentation builder |
Read our verdict in the software roundup.
 Explore our comprehensive directory of recommended free and open source software. Our carefully curated collection spans every major software category.This directory is part of our ongoing series of informative articles for Linux enthusiasts. It features hundreds of detailed reviews, along with open source alternatives to proprietary solutions from major corporations such as Google, Microsoft, Apple, Adobe, IBM, Cisco, Oracle, and Autodesk. You’ll also find interesting projects to try, hardware coverage, free programming books and tutorials, and much more. Discovered a useful open source Linux program that we haven’t covered yet? Let us know by completing this form. |