Overview:

Znai is a tool that allows developers to build functional, maintainable, and beautiful user guides. It is a markdown-based tool with custom extensions and plugins. Znai supports content from external files, simplified extraction of function body content, and embedding of documentation text from JavaDoc/PyDoc. It also provides rich visual capabilities such as flow diagrams, charts, and cards. Znai offers instant page navigation, local search, and multiple integrations with Python, Java, and OpenAPI. It has a presentation mode that automatically transforms the documentation into slides. Znai also supports dark/light runtime themes and can leverage automated test results to enhance the documentation. It is GitHub pages friendly and allows for embedding of external resources at build-time. Znai offers a beautiful way to document APIs and supports a two-sides layout option for rendering examples and supporting information side by side. It provides blazing fast local search with results preview and has a preview mode for easy development. Znai also offers a Docs Hub for hosting multiple documentations within a single site.

Features:

Custom Extensions and Plugins: Znai supports custom extensions and dozens of plugins for markdown, allowing for flexible and enhanced documentation.
Content from External Files: Znai allows for including content from external files with support for markers and filters, making it easy to add and manage content from different sources.
Simplified Extraction of Function Body Content: Znai simplifies the extraction of function body content, making it convenient to include code examples and documentation related to specific functions.
Embedding of JavaDoc/PyDoc Documentation Text: Znai supports embedding JavaDoc/PyDoc documentation text, preserving the original styles and formatting.
Rich Visuals: Znai offers rich visual capabilities such as flow diagrams, charts, and cards, allowing for clear and visually appealing documentation.
Instant Pages Navigation: Znai provides instant navigation between pages, making it easy to find and access specific sections within the documentation.
Local Search: Znai offers a blazing-fast local search feature with results preview, enabling quick and efficient searching within the documentation.
Multiple Integrations: Znai supports multiple integrations with Python, Java, OpenAPI, and more, allowing for seamless integration of code and documentation.
Presentation Mode: Znai has a presentation mode that automatically transforms the documentation into slides, making it easy to present and share the documentation with others.
Dark/Light Runtime Themes: Znai supports dark and light runtime themes, allowing users to customize the appearance of the documentation based on their preferences.
Automated Test Results: Znai can leverage automated test results to enrich the documentation with annotated images, REST responses, CLI outputs, and more, providing comprehensive and detailed documentation.
GitHub Pages Friendly: Znai is GitHub pages friendly, making it easy to host the documentation on GitHub and collaborate with others.
Embedding of External Resources: Znai allows for embedding external resources at build time, making it possible to include code snippets, examples, and more from external sources.
Two Sides Layout Option: Znai supports a two-sides layout option, where examples and supporting information can be rendered side by side, with a convenient language switch for examples.
Docs Hub: Znai provides a Docs Hub for hosting multiple documentations using a single site. It offers a landing page to list all the company's inner guides and automatically detects documentations in the builds outputs, updating the hosted documentations accordingly.

Testingisdocumenting

Znai