MkDocs
22 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 (BSD-2-Clause)
Application typeApplication types
Platforms
- Self-Hosted
- Python
Features
MkDocs News & Activities
Highlights All activities
Recent News
No news, maybe you know any news worth sharing?
Share a News Tip
Recent activities
Simon Moxon added MkDocs as alternative to SupportPages.io
Peter Mello added MkDocs as alternative to ProperDocs- leahyra liked MkDocs
Ghosts added MkDocs as alternative to Moxie Docs
Featured in Lists
My Setup - All Apps and Software
Master List of all Apps and Software I use for both work and personal life.
Top tools for a Technical Writer
When you are working with content on a daily basis, probably you already have a list of your favorite apps, tools, and services that allow you to work faster with texts and documentation. That's great! But chances are that this list is not perfect. "Fast" is not always equals "efficient".
Sometimes, when you urgently need a new tool for a specific purpose, you just type your search request and then choose the "most relevant" app from the top of the search results. Regardless of its usefulness, this app tends to stay in the favorites forever. As practice shows, this is rather an inefficient method.
This was my case previously. But now, I'm always trying to take some time to compare my new apps with some alternatives and find out whether my choice is the best one. Kind of trials and errors. This is, actually, the way how this list appeared. So, let me share my thoughts on what apps, tools, and services a seasoned Technical Writer must use. Or at least try.
markdown and markup language
A list with 13 apps by kaekazeh without a description.
What is MkDocs?
MkDocs information
Developed by
Tom Christie Licensing
Open Source (BSD-2-Clause) and Free product.Written in
Rating
Average rating of 3.6Alternatives
80 alternatives listedBadge
Get an embeddable badge for MkDocsSupported Languages
AlternativeTo Category
DevelopmentGitHub repository
- 22,489 Stars
- 2,653 Forks
- 192 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.