Bad doccumentation is better than none. My small solution to build awesome docs.

I've made this tool to make good-looking documentation (static websites) from potentially multiple repositories. Has many features, including full-text search, diagrams, markdown.

Example of documentation website you can easily make with it

https://mkdocs-magicspace.alnoda.org

Has lots of niceties, installed packages, and a fully configured environment in the docker image.

docker run –name space-1 -d -p 8020-8035:8020-8035 alnoda/mkdocs-magicspace

and open browser on localhost:8020

I hope it will help someone to make awesome docs!

submitted by /u/Bluxmit
[link] [comments]

from Software Development – methodologies, techniques, and tools. Covering Agile, RUP, Waterfall + more! https://ift.tt/plyXCDm

Leave a comment

Design a site like this with WordPress.com
Get started
search previous next tag category expand menu location phone mail time cart zoom edit close