Mkdocs
If you are okay with MarkDown, writing software, and documentation, then I highly suggest using MkDocs. This Python based project starts
with a mkdocs.yml
file to describe the project, navigation, options, theme, and plugins. Its very straight forward and easy to use. I
have an article about how I think its better than wiki for engineers.
Getting started with MkDocs is pretty easy, but I have come up with a method that might make things even easier. The following project
streamline this with a container defined in a Dockerfile
.
Easy-MkDocs
I created a simple project called Easy-MkDocs
to help in running mkdocs
a little easier with containers.
Please use if you find it helpful.