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)
Buy Linux Magazine
US / Canada
UK / Australia
Subscribe to our Linux Newsletters
Find Linux and Open Source Jobs
Subscribe to our ADMIN Newsletters
Support Our Work
Linux Magazine content is made possible with support from readers like you. Please consider contributing when you’ve found an article to be beneficial.
News
-
Canonical Releases Ubuntu 24.04
After a brief pause because of the XZ vulnerability, Ubuntu 24.04 is now available for install.
-
Linux Servers Targeted by Akira Ransomware
A group of bad actors who have already extorted $42 million have their sights set on the Linux platform.
-
TUXEDO Computers Unveils Linux Laptop Featuring AMD Ryzen CPU
This latest release is the first laptop to include the new CPU from Ryzen and Linux preinstalled.
-
XZ Gets the All-Clear
The back door xz vulnerability has been officially reverted for Fedora 40 and versions 38 and 39 were never affected.
-
Canonical Collaborates with Qualcomm on New Venture
This new joint effort is geared toward bringing Ubuntu and Ubuntu Core to Qualcomm-powered devices.
-
Kodi 21.0 Open-Source Entertainment Hub Released
After a year of development, the award-winning Kodi cross-platform, media center software is now available with many new additions and improvements.
-
Linux Usage Increases in Two Key Areas
If market share is your thing, you'll be happy to know that Linux is on the rise in two areas that, if they keep climbing, could have serious meaning for Linux's future.
-
Vulnerability Discovered in xz Libraries
An urgent alert for Fedora 40 has been posted and users should pay attention.
-
Canonical Bumps LTS Support to 12 years
If you're worried that your Ubuntu LTS release won't be supported long enough to last, Canonical has a surprise for you in the form of 12 years of security coverage.
-
Fedora 40 Beta Released Soon
With the official release of Fedora 40 coming in April, it's almost time to download the beta and see what's new.