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
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
-
New Slimbook EVO with Raw AMD Ryzen Power
If you're looking for serious power in a 14" ultrabook that is powered by Linux, Slimbook has just the thing for you.
-
The Gnome Foundation Struggling to Stay Afloat
The foundation behind the Gnome desktop environment is having to go through some serious belt-tightening due to continued financial problems.
-
Thousands of Linux Servers Infected with Stealth Malware Since 2021
Perfctl is capable of remaining undetected, which makes it dangerous and hard to mitigate.
-
Halcyon Creates Anti-Ransomware Protection for Linux
As more Linux systems are targeted by ransomware, Halcyon is stepping up its protection.
-
Valve and Arch Linux Announce Collaboration
Valve and Arch have come together for two projects that will have a serious impact on the Linux distribution.
-
Hacker Successfully Runs Linux on a CPU from the Early ‘70s
From the office of "Look what I can do," Dmitry Grinberg was able to get Linux running on a processor that was created in 1971.
-
OSI and LPI Form Strategic Alliance
With a goal of strengthening Linux and open source communities, this new alliance aims to nurture the growth of more highly skilled professionals.
-
Fedora 41 Beta Available with Some Interesting Additions
If you're a Fedora fan, you'll be excited to hear the beta version of the latest release is now available for testing and includes plenty of updates.
-
AlmaLinux Unveils New Hardware Certification Process
The AlmaLinux Hardware Certification Program run by the Certification Special Interest Group (SIG) aims to ensure seamless compatibility between AlmaLinux and a wide range of hardware configurations.
-
Wind River Introduces eLxr Pro Linux Solution
eLxr Pro offers an end-to-end Linux solution backed by expert commercial support.