Description:
Project documentation with Markdown
|
|
Type: Formula
|
Tracked Since: Dec 28, 2025
|
|
Links:
Homepage |
@mkdocs |
formulae.brew.sh
|
|
Category: Developer tools
|
|
Tags:
documentation
markdown
static-site
docs-as-code
python
|
|
Install:
brew install mkdocs
|
About:
MkDocs is a static site generator designed for project documentation. It converts Markdown files into a static HTML site with a clean, modern interface. Its primary value is enabling developers to write documentation in simple Markdown and deploy it quickly without complex setup.
|
Key Features:
- Built in Python with a simple YAML configuration
- Live reloading for instant preview during editing
- Extensive theme customization and plugin ecosystem
- Supports internationalization (i18n)
|
Use Cases:
- Creating technical documentation for software projects
- Building internal knowledge bases or wikis
- Hosting project documentation alongside code on GitHub Pages
|
Alternatives:
-
Sphinx
– More powerful for large Python projects but has a steeper learning curve
-
Docusaurus
– React-based framework better suited for content-heavy sites requiring complex interactivity
|
| Detected |
Version |
Rev |
Change |
Commit |
| Sep 16, 2025 5:45am |
|
2 |
VERSION_BUMP |
786280aa |
| Nov 8, 2024 2:23am |
|
0 |
VERSION_BUMP |
e2e7307b |
| Oct 12, 2024 10:22pm |
|
0 |
VERSION_BUMP |
fc6ed8ca |
| Aug 30, 2024 12:43pm |
|
0 |
VERSION_BUMP |
c2f39e46 |
| May 7, 2024 11:41pm |
|
1 |
VERSION_BUMP |
8776c041 |
| Apr 20, 2024 4:14pm |
|
0 |
VERSION_BUMP |
08e8bb40 |
| Feb 15, 2024 8:43am |
|
1 |
VERSION_BUMP |
ebbef7a5 |
| Nov 15, 2023 10:07pm |
|
0 |
VERSION_BUMP |
2e3c1b2e |
| Oct 15, 2023 4:37pm |
|
0 |
VERSION_BUMP |
5230430f |
| Sep 29, 2023 10:49pm |
|
0 |
VERSION_BUMP |
06ad46d5 |
| Sep 10, 2023 9:46pm |
|
0 |
VERSION_BUMP |
719089a6 |
| Sep 10, 2023 12:42pm |
|
0 |
VERSION_BUMP |
f80ba65f |
| May 3, 2023 3:38am |
|
0 |
VERSION_BUMP |
b3b536ae |
|