https://github.com/dimasmith/znai-rust-showcase

An example of setting up Znai documentation for projects not in Java
https://github.com/dimasmith/znai-rust-showcase

Last synced: 4 months ago
JSON representation

An example of setting up Znai documentation for projects not in Java

• Host: GitHub
• URL: https://github.com/dimasmith/znai-rust-showcase
• Owner: dimasmith
• License: mit
• Created: 2023-06-04T09:15:46.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2026-02-17T01:36:10.000Z (4 months ago)
• Last Synced: 2026-02-17T08:06:05.859Z (4 months ago)
• Language: Rust
• Homepage: https://dimasmith.github.io/znai-rust-showcase/
• Size: 39.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Znai rust showcase

[![Publish Documentation](https://github.com/dimasmith/znai-rust-showcase/actions/workflows/znai-pages-deploy.yaml/badge.svg)](https://github.com/dimasmith/znai-rust-showcase/actions/workflows/znai-pages-deploy.yaml)

This project is a showcase for using [Znai](https://testingisdocumenting.org/znai) to provide a documentation for non-java projects.

It contains instructions and example actions to build Znai documentation and publish it as GitHub pages.

## What is Znai?

Znai is a tool for documenting projects. 

It uses markdown with extensions to build awesome documentation websites.

Znai is focused on software projects.

It has multiple handy features to work with source code, diagrams, OpenAPI specs, and other things. 

You can even run a presentation from the generated Znai pages.

## Where can I see the results

The documentation of this repository is published as [GitHub pages](https://dimasmith.github.io/znai-rust-showcase/tutorial/create-documentation). 

You will find a tutorial on how to configure and publish Znai documentation for your project.