Top Qs
Timeline
Chat
Perspective
MkDocs
Documentation generator From Wikipedia, the free encyclopedia
Remove ads
MkDocs is static site generator designed for building project documentation. It is written in Python, and also used in other environments.
 | This article has multiple issues. Please help improve it or discuss these issues on the talk page. (Learn how and when to remove these messages)
|
Remove ads
Remove ads
Mode of operation
MkDocs converts Markdown files into HTML pages, effectively creating a static website containing documentation.
Markdown is extensible, and the MkDocs ecosystem exploits its extensible nature through a number of extensions[2][3] that help with for autogenerating documentation from source code, adding admonitions, writing mathematical notation, inserting footnotes, highlighting source code etc.
Remove ads
Themes
MkDocs provides two built-in themes, default theme (based on Bootstrap) and Read the Docs theme. Many of the available third-party themes are listed in the official catalog,[4] including the popular Material for MkDocs theme.[5]
History
The first tagged version of MkDocs, version 0.2, came out on January 21, 2014.[6]
By early 2015, Read the Docs supported building documentation with MkDocs, in addition to Sphinx. In preparation for the 0.12 release,[7] MkDocs started using Read the Docs for hosting.[8]
In January 2016, MkDocs added support for installable themes.[9] Next month, Martin Donath started developing Material for MkDocs theme. In the following years, the theme became very popular and in July 2020 the development model was changed to sponsorware, where the new features get released to the Insiders version first and become publicly available after funding goals are hit.[10]
Usage
MkDocs offers built-in support for deployment to GitHub Pages. Alternatives, such as GitLab and Cloudflare Pages, offer first-party support for deploying MkDocs sites.[11][12]
Many companies use MkDocs with the Material theme to deploy their documentation, including Atlassian,[13] Google,[14] Microsoft,[15] and Red Hat.[16] It is also a popular choice among open source projects, such as Electron,[17] Kubernetes,[18] and WebKit.[19]
A major benefit of MkDocs verses other static site generators is that all the files you edit for content are pure markdown files. In contrast, jekyll, a much more popular generator due to integration/branding with github, uses yaml at the top of every markdown page that may be daunting or annoying for writers and also cannot be interpreted by many standard markdown generators, such as medium, github.com, visual studio code extensions, etc.
Remove ads
See also
References
External links
Wikiwand - on
Seamless Wikipedia browsing. On steroids.
Remove ads