Documentation · head to head
MkDocs vs Read the Docs
MkDocs
Documentation
Static site generator for project documentation in Markdown
- From
- Free
- Rated
- -
Read the Docs
Documentation
Documentation hosting with versioning built for open source
- From
- Free
- Rated
- -
The short version
- Each has a real cost: MkDocs no built-in versioning, which Docusaurus provides and documentation teams eventually need; Read the Docs build configuration is finicky, and build failures on dependency changes are a common frustration
- They diverge on capability: MkDocs covers Plain Markdown, Read the Docs covers Build on commit.
Where they differ
Only the attributes on which MkDocs and Read the Docs actually diverge.
| Attribute | MkDocs | Read the Docs |
|---|---|---|
| Pricing model | Open source, no licence fee | Free for open source; paid business plans for private documentation |
| Platforms | Web, Linux, macOS, Windows | Web, Cloud |
Identical on both: starting price (Free), free tier (Yes), user rating (Not yet rated), category (Documentation).
What each one covers
Drawn from each product's published feature list. An absence here means we hold no record of it - not that the product lacks it.
Only in MkDocs
- Plain Markdown
- Single YAML config
- Material theme
- Live preview
Only in Read the Docs
- Build on commit
- Version by branch and tag
- Pull request previews
- Free for open source
What people use each for
The jobs each tool is most often brought in to do.
MkDocs
- Project documentation for teams that would rather not run a JavaScript toolchainnot Read the Docs
- Python projects keeping docs beside the codenot Read the Docs
- Documentation that must build fast in CI on every commitnot Read the Docs
Read the Docs
- Open-source projects needing free hosted versioned documentationnot MkDocs
- Teams wanting docs rebuilt automatically on every commitnot MkDocs
- Reviewing documentation changes in a pull request before mergenot MkDocs
Where each one falls short
Documented limitations, not opinions. Every one is a constraint you would hit in normal use.
MkDocs
- No built-in versioning, which Docusaurus provides and documentation teams eventually need
- Extending past the theme means writing Python plugins
- Markdown only, so embedding interactive components is not the model
Read the Docs
- Build configuration is finicky, and build failures on dependency changes are a common frustration
- Default themes are recognisable and dated, so sites look alike unless customised
- Private documentation requires a paid business plan
- Build times on large projects are slow enough to interrupt a review cycle
Pricing, plan by plan
MkDocs
Free- MkDocsFree
- Full functionality
- Commercial use permitted
- Community support
Read the Docs
Free- FreeFree
- Core functionality
- Public projects
Which should you pick?
Choose MkDocs if
- You need plain markdown.
- You want to start without paying.
- You work on Web, Linux, macOS, Windows.
- You also want single yaml config.
Choose Read the Docs if
- You need build on commit.
- You want to start without paying.
- You work on Web, Cloud.
- You also want version by branch and tag.
Questions people ask
- Is MkDocs or Read the Docs better?
- Neither clearly leads. MkDocs starts at Free and Read the Docs at Free, and user ratings are close enough to be indistinguishable. Choose on capability and platform support.
- Which is cheaper, MkDocs or Read the Docs?
- MkDocs starts at Free and Read the Docs at Free.
- Does MkDocs or Read the Docs run on more platforms?
- MkDocs runs on Web, Linux, macOS, Windows. Read the Docs runs on Web, Cloud.
- Can I use MkDocs for free?
- Both have a free tier, so you can try either at no cost before committing.
- What is MkDocs best used for?
- MkDocs is most often used for project documentation for teams that would rather not run a javascript toolchain, python projects keeping docs beside the code, documentation that must build fast in ci on every commit. Of those, project documentation for teams that would rather not run a javascript toolchain and python projects keeping docs beside the code are not what Read the Docs is typically brought in for.
- What can MkDocs do that Read the Docs cannot?
- MkDocs covers Plain Markdown, Single YAML config, Material theme, Live preview. Read the Docs covers Build on commit, Version by branch and tag, Pull request previews, Free for open source.
Answered from the vendors’ own pages
MkDocs: Is MkDocs free?
Yes, open source under the BSD licence. The Material theme has a free version and a paid Insiders edition.
Read the Docs: Is Read the Docs free?
Free for open-source public projects. Private documentation requires a paid business plan.
MkDocs: MkDocs or Docusaurus?
MkDocs is simpler and faster to adopt, especially for Python teams. Docusaurus offers versioning, internationalisation and React components, which matter once documentation grows.
Read the Docs: What does it build from?
Most commonly Sphinx or MkDocs sources kept in your repository.
MkDocs: Does MkDocs support versioned docs?
Not natively. Plugins such as mike add it, where Docusaurus includes versioning in core.
Read the Docs: How does versioning work?
It maps branches and tags to documentation versions, so several releases are served side by side without manual work.