MkDocs is a fast, simple and downright gorgeous 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.
Comments and Reviews Post a comment / reviewSort: relevance • date
luarocks
★
★
★
★
★
• Positive comment • 10 months ago • 0 replies
Perfect online-wiki tool. Support all features that I can only wish as extensions.
Show entire comment ▾
alexandrezanni
★
★
★
★
★
• Negative comment • 10 months ago • 0 replies
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]
Show entire comment ▾
wlmg
★
★
★
★
★
• Review • 5 days ago • 0 replies
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.
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 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