/znai

Rich documentation generator (markdown and java based)

Primary LanguageJavaScriptApache License 2.0Apache-2.0

Znai

Znai transforms Markdown files into rich, well-structured documentation served in a web front-end built on React. It provides many custom add-ons that supercharge basic generated docs with advanced layout features, dynamic references to code and test artifacts, and many visual and functional enhancements.

User guide: https://testingisdocumenting.org/znai/

Developer Setup

Build requires "dot" from the graphviz project to be available on the $PATH.

MacOS

brew install graphviz

Ubuntu/Debian

sudo apt-get install graphviz