MkDocs
MkDocs is static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a singl...
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 Screenshots
MkDocs Features
MkDocs information
- Developed byTom Christie
- LicensingOpen Source (BSD-2-Clause) and Free product.
- Written in
- RatingAverage rating of 3.5
- Alternatives47 alternatives listed
Supported Languages
- English
GitHub repository
- 15,806 Stars
- 2,167 Forks
- 137 Open Issues
- Updated
Comments and Reviews
Tags
- static-generator
- Documentation
- Documentation Generator
So powerful while being simple, open, extensible and based on markdown.
Perfect online-wiki tool. Support all features that I can only wish as extensions.
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/
Reply written ago
Yay I tried it and it's a lot better.
Reply written ago
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