vladimiratwork / znai

Rich documentation generator (markdown and java based)

Home Page:https://testingisdocumenting.org/znai

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

About

Rich documentation generator (markdown and java based)

https://testingisdocumenting.org/znai

License:Apache License 2.0


Languages

Language:JavaScript 37.7%Language:Java 36.8%Language:Groovy 12.4%Language:CSS 5.8%Language:TypeScript 3.6%Language:ANTLR 2.6%Language:Jupyter Notebook 0.5%Language:Python 0.3%Language:HTML 0.1%Language:C++ 0.1%Language:Makefile 0.0%Language:Shell 0.0%Language:C 0.0%