{"repo":"testingisdocumenting/znai","free":true,"listed":false,"github":"https://github.com/testingisdocumenting/znai","clone":"git clone https://github.com/testingisdocumenting/znai.git","description":"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.","language":"Java","stars":280,"topics":["documentation","userguide","markdown","java","openapi","openapi3","python","static-site-generator","github-pages","rest-api"],"license":"Apache-2.0","category":"docs-static-sites","readme_excerpt":"Discord Server Join Testing Is Documenting Discord Server 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 Embedding of External Resources at build time Rich Visuals such as Charts, Flow Diagrams and Cards Dark/Light mode switching Cards support Beautiful way to document your API Use two sides layout option to render examples and supporting information side by side with convenient examples language switch Blazing fast local search with results preview Automatic Presentation from the same content with zero config Preview Znai has a preview mode to automatically listen to local files changes. It automatically navigates to a page that was changed (dir","default_branch":null,"files":null,"tree":[],"storefront":"/r/testingisdocumenting","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/testingisdocumenting/znai/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}