Beautiful and Maintainable User Guide
combines human written text with artifacts such as etc to create up to date maintainable beautiful User Guides and Tutorials Znai code graphs REST API Java Docs Doxygen # Beautiful and Maintainable User Guide `Znai` combines human written text with artifacts such as `code` `graphs` `REST API` `Java Docs` `Doxygen` etc to create up to date maintainable beautiful **User Guides** and **Tutorials** include flow chart artifacts flow json vertical true highlight userguide
extends markdown with plugins system to supercharge visuals and maintainability Three categories of plugins are available for usage and creation Include Inlined Code It is a day is ticking Fenced Block C content of C tab Java content of Java tab Python content of Python tab Znai include json example json title JSON example highlightValue root person id collapsedPaths root details include java java HelloWorld java entry sampleMethod bodyOnly true commentsType inline validate process p2 important comment notifyAll p1 very important return bestSample It is a ` icon cloud` day ` icon clock` is ticking ```tabs C content of C tab Java content of Java tab Python content of Python tab ```
Leverage multiple out of the box plugins to render charts flow diagrams annotated images dynamic SVGs etc
Generate one documentation and let your users switch Dark Light theme at runtime
Use two sides layout option to render examples and supporting information side by side with convenient examples language switch
Local search with preview and instant navigation to the result
With a click of a button turns User Guide content to presentation slides Single source of truth and minimal effort Present a feature in a meeting and then share the same content as a link to the documentation Znai
Znai comes with Markdown with custom extensions and dozens of plugins Content from external files with markers and filters support Simplified extraction of a function body content working with examples Embedding of JavaDoc PyDoc documentation text preserving styles Beautiful API documentation capabilities Two Sides Page Layout with convenient examples language switch Rich visuals like flow diagrams and charts etc Dev server mode with changes highlight and auto jump to a change Local search with full preview Dark light mode runtime switch Presentation Mode to automatically turn your documentation into slides using the same content