Skip to content

Build functional, maintainable, beautiful User Guides with markdown and Znai plugins. Instant pages navigation. Local search. Multiple integrations to work with Python, Java, C++, OpenAPI, etc. Transform "getting started" sections into slideshow for your workshops. Manage multiple documentations with self-deployed znai hub.

License

testingisdocumenting/znai

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.

Znai

Build functional, maintainable, beautiful User Guides with Znai.

  • 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 Option with convenient example languages switch
    • Rich visuals like flow diagrams and charts
    • etc
  • Instant pages navigation
  • Local search
  • Multiple integrations to work with Python, Java, OpenAPI, etc
  • Presentation Mode to automatically turn your documentation into slides, using the same content
  • Dark/Light runtime themes
  • Leverage automated test results to enrich your documentation with annotated images, REST responses, CLI outputs, etc
  • GitHub pages friendly

generated site example

Embedding of External Resources at build time

generated site example of external code

Rich Visuals such as Charts and Flow Diagrams

generated site example of charts

Dark/Light mode switching

generated site example of flow diagram

Beautiful way to document your API

generated site example of api params

Use two sides layout option to render examples and supporting information side by side with convenient examples language switch

generated site example of two sides layout

Blazing fast local search with results preview

generated site example of search

Automatic Presentation from the same content with zero config

generated site example of presentation mode

Preview

Znai has a preview mode to automatically listen to local files changes. It automatically navigates to a page that was changed (directly or indirectly) and highlights the changes.

Docs Hub

Znai has a free, open-source enterprise support. You can host multiple documentations using single site. It provides landing page to list all the company inner guides.

It also automatically detects documentations in the builds outputs and updates hosted documentations.

Examples (including using Google Cloud) and setup documentation are coming. Please create a GitHub issue if you want to learn more about Enterprise setup. It will help me prioritize.

Read More

Znai documentation website built with Znai

For curios, znai word meaning: znai is a to know in Ukranian and is a prefix for words like knoweldge are built on.

About

Build functional, maintainable, beautiful User Guides with markdown and Znai plugins. Instant pages navigation. Local search. Multiple integrations to work with Python, Java, C++, OpenAPI, etc. Transform "getting started" sections into slideshow for your workshops. Manage multiple documentations with self-deployed znai hub.

Topics

Resources

License

Stars

Watchers

Forks