MkDocs
20 likes
MkDocs is static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
Cost / License
- Free
- Open Source
Application types
Platforms
- Self-Hosted
- Python
Features
Properties
- Support for Themes
- Lightweight
Features
- Extensible by Plugins/Extensions
- Static Site Generator
- Support for MarkDown
- Works Offline
- Ad-free
Tags
- static-generator
- Documentation
MkDocs News & Activities
Highlights All activities
Recent News
No news, maybe you know any news worth sharing?
Share a News TipRecent activities
mateuszwozniak added MkDocs as alternative to Produkt.so
RogueScholar added MkDocs as alternative to Material for MkDocs
ralaud added MkDocs as alternative to Quartz – Static Site Generator
Featured in Lists
Master List of all Apps and Software I use for both work and personal life.
List by Jimmy Briggs with 421 apps, updated
When you are working with content on a daily basis, probably you already have a list of your favorite apps, tools, and …
List by RemovedUser with 14 apps, updated
A list with 13 apps by kaekazeh without a description.
List by kaekazeh with 13 apps, updated
What is MkDocs?
MkDocs is static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
MkDocs information
Developed by
Tom Christie Licensing
Open Source (BSD-2-Clause) and Free product.Written in
Alternatives
69 alternatives listedSupported Languages
- English
AlternativeTo Category
DevelopmentGitHub repository
- 21,519 Stars
- 2,579 Forks
- 139 Open Issues
- Updated
Comments and Reviews
So powerful while being simple, open, extensible and based on markdown.
Clunky documentation tool, supports the very old original markdown syntax not CommonMark (best) or GFM (okish). So writting doc is a nightmare as you don't have autolink without a plugin, you need to have exactly 4 spaces for lists (2 doesn't work) no table support, etc.
Also the dependencies are often breaking while installing, and the maintainer is stuborn and doesn't want any new features.
[Edited by alexandrezanni, September 01]
I would advice a tool I wrote, NextBook for you, literally one-click deployment. http://next-book.vercel.app/
Yay I tried it and it's a lot better.
I like mkdocs because its so easy to set up. However, if you're planning to use versioning — you'll have quite a bit of trouble as there is no native support for it and the extensions available are still in the 'workaround' state
Perfect online-wiki tool. Support all features that I can only wish as extensions.