https://github.com/testingisdocumenting/znai

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.
https://github.com/testingisdocumenting/znai

documentation github-pages java markdown openapi openapi3 python rest-api static-site-generator userguide

Last synced: 1 day ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/testingisdocumenting/znai
• Owner: testingisdocumenting
• License: apache-2.0
• Created: 2016-12-16T16:42:12.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-04-17T11:40:54.000Z (8 months ago)
• Last Synced: 2024-04-18T04:49:03.017Z (8 months ago)
• Topics: documentation, github-pages, java, markdown, openapi, openapi3, python, rest-api, static-site-generator, userguide
• Language: Java
• Homepage: https://testingisdocumenting.org/znai
• Size: 43.6 MB
• Stars: 233
• Watchers: 12
• Forks: 13
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Discord Server

Join `Testing Is Documenting` [Discord Server](https://discord.gg/aEHbzXTX6N) to ask questions and discuss features/bugs

# 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, charts and cards

  * 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](znai-docs/readme/znai-overview.png)

Embedding of [External Resources](https://testingisdocumenting.org/znai/snippets/external-code-snippets) at build time

![generated site example of external code](znai-docs/readme/znai-external-code.png)

Rich Visuals such as [Charts](https://testingisdocumenting.org/znai/visuals/charts),

[Flow Diagrams](https://testingisdocumenting.org/znai/visuals/flow-diagrams) and

[Cards](https://testingisdocumenting.org/znai/visuals/cards)

![generated site example of charts](znai-docs/readme/znai-charts.png)

Dark/Light mode switching 

![generated site example of flow diagram](znai-docs/readme/znai-flow-diagram.png)

Cards support

![generated site example of cards](znai-docs/readme/znai-cards.png)

Beautiful way to document your API 

![generated site example of api params](znai-docs/readme/znai-api-parameters.png)

Use [two sides](https://testingisdocumenting.org/znai/layout/two-sides-tabs) layout option to render examples and supporting information side by side

with convenient examples language switch

![generated site example of two sides layout](znai-docs/readme/znai-two-sides-tabs.png)

Blazing fast local search with results preview

![generated site example of search](znai-docs/readme/znai-search.png)

Automatic Presentation from **the same content** with zero config

![generated site example of presentation mode](znai-docs/readme/znai-presentation.png)

# 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](https://testingisdocumenting.org/znai/)

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

# Developers Setup

[Local Build](https://testingisdocumenting.org/znai/znai-development/local-build)