Building project documentation from Markdown files
Publish on GitHub
The mkdocs build
command generates a ready-to-publish static documentation site that you can upload to a remote server. To optimize the publishing process, you can create a shell script that uses rsync to push changes to the remote server every time you rebuild the documentation.
MkDocs has yet another clever feature that further simplifies the task of publishing documentation. If you happen to use GitHub, you can use MkDocs to deploy documentation to GitHub Pages. To do this, switch to the documentation project repository and run the mkdocs gh-deploy
command. This publishes the documentation in the gh-pages
branch of the project. That's all there is to it.
Wrap-Up
MkDocs is not the only documentation publishing tool out there. But if you need a solution that is easy to master, provides all basic capabilities right out of the box, and can grow with your needs, you should give MkDocs a try.
Infos
- MkDocs: https://www.mkdocs.org
- Material for MkDocs: https://squidfunk.github.io/mkdocs-material/
- Material color settings: https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/
- Python Markdown Extensions: https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/
- PyPI: https://pypi.org
- Awesome Pages: https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin/blob/master/README.md
« Previous 1 2
Buy this article as PDF
(incl. VAT)