These docs use MkDocs.
pip install mkdocs
- Docs live in the
docs
directory. Write and structure using subdirectories (with theindex.md
being home for a directory). mkdocs serve
to see how they look before deploying- When it looks good, use
./deploy.sh
to push the rendered documentation up for view at mesos-magellan.github.io. - Commit your changes when ready.
git commit -am "Relevant short commit message"
git push origin content