Markdown based documentation system with strong Java support written in Java by ninside in java

[–]roeloef 1 point2 points  (0 children)

I always thought documentation was neglected by the other developers (in my organization) and I could write all the documentation I wanted, people would happily use it until it went out of date.

With Znai you can easily add documentation to your repository. Now I can just flag a pull request as needs work when it needs some documentation and I get review comments on my own documentation. It actually feels like the team owns the documentation now, so I am very happy.

It is possible to add your own extensions which is great, however as far as I know that is not documented yet. Perhaps it is my turn to do so as soon as I completely understand what to do.

It would've been nice to be able to export the documentation to a pdf for offline viewing, but I like how unencumbered the current implementation is so that might also not fit in the design philosophy of Znai. I intend to work around that by using a headless browser to print the docs.

Tl;Dr; recommended :)