4 ms·
Show HN: Markdown based documentation with rich visuals and useful plugins
- ninside 4y agoHey all, author is here. znai is the passion project of mine that I started many years ago and coded mostly during my commute. It started as hack project at one of my work places and later was open sourced and changed domains after I changed jobs. It does solve documentation problems I encounter on a regular basis with a focus on making it easier to leverage artifacts around you: code snippets, test captured results, diagrams. One of the most recent releases made it easier to include plots into your documentation: https://testingisdocumenting.org/znai/visuals/charts https://testingisdocumenting.org/znai/visuals/charts Znai also has built-in presentation mode that turns your existing documentation pages into slides so you can share new features of your product on zoom calls. This encourages me personally to write more documentation with an easy to follow flow.
- jdenning 4y agoThis looks great, thanks for sharing! It took me a minute to figure out exactly what the usefulness of this project is. I suggest emphasizing that this enables you to include content from external files in a markdown document and keep it updated. Once I saw how easy it was to include the source code of a specific function from an external file, I was sold! (Edit: clarifying)
- ninside 4y agoThank you! I updated readme of the GitHub, do you have more suggestion on it?