MkDocs
 | |
| Developer(s) | Tom Christie, Dougal Matthews, Waylan Limberg, Oleh Prypin, Ultrabug |
|---|---|
| Initial release | October 29, 2014 |
| Stable release | 1.5.3[1]
/ September 18, 2023 |
| Repository | |
| Written in | Python |
| Operating system | Cross-platform |
| Type | Documentation generator |
| License | BSD |
| Website | www |
Sphinx is static site generator designed for building project documentation. It is written in Python, and also used in other environments.
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.
Themes
MkDodcs 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].
See also
References
- ^ "Release Notes". MkDocs.
- ^ "Extensions — Python-Markdown 3.4.4 documentation". python-markdown.github.io. Retrieved 2023-09-23.
- ^ "Pymdown Extensions - PyMdown Extensions Documentation". facelessuser.github.io. Retrieved 2023-09-23.
- ^ Theming catalog, MkDocs, 2023-09-23, retrieved 2023-09-23
- ^ Donath, Martin. "Material for MkDocs". squidfunk.github.io. Retrieved 2023-09-23.
External links
- MkDocs
- Read the Docs large-scale, collaborative documentation host powered by Sphinx, MkDocs, and Jupyter Book