Documentation · head to head
Read the Docs vs MkDocs
Read the Docs
Documentation
Documentation hosting with versioning built for open source
- From
- Free
- Rated
- -
MkDocs
Documentation
Static site generator for project documentation in Markdown
- From
- Free
- Rated
- -
The short version
- Each has a real cost: Read the Docs build configuration is finicky, and build failures on dependency changes are a common frustration; MkDocs no built-in versioning, which Docusaurus provides and documentation teams eventually need
- They diverge on capability: Read the Docs covers Build on commit, MkDocs covers Plain Markdown.
Where they differ
Only the attributes on which Read the Docs and MkDocs actually diverge.
| Attribute | Read the Docs | MkDocs |
|---|---|---|
| Pricing model | Free for open source; paid business plans for private documentation | Open source, no licence fee |
| Platforms | Web, Cloud | Web, Linux, macOS, Windows |
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 Read the Docs
- Build on commit
- Version by branch and tag
- Pull request previews
- Free for open source
Only in MkDocs
- Plain Markdown
- Single YAML config
- Material theme
- Live preview
What people use each for
The jobs each tool is most often brought in to do.
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
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
Where each one falls short
Documented limitations, not opinions. Every one is a constraint you would hit in normal use.
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
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
Pricing, plan by plan
Read the Docs
Free- FreeFree
- Core functionality
- Public projects
MkDocs
Free- MkDocsFree
- Full functionality
- Commercial use permitted
- Community support
Which should you pick?
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.
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.
Questions people ask
- Is Read the Docs or MkDocs better?
- Neither clearly leads. Read the Docs starts at Free and MkDocs at Free, and user ratings are close enough to be indistinguishable. Choose on capability and platform support.
- Which is cheaper, Read the Docs or MkDocs?
- Read the Docs starts at Free and MkDocs at Free.
- Does Read the Docs or MkDocs run on more platforms?
- Read the Docs runs on Web, Cloud. MkDocs runs on Web, Linux, macOS, Windows.
- Can I use Read the Docs for free?
- Both have a free tier, so you can try either at no cost before committing.
- What is Read the Docs best used for?
- Read the Docs is most often used for open-source projects needing free hosted versioned documentation, teams wanting docs rebuilt automatically on every commit, reviewing documentation changes in a pull request before merge. Of those, open-source projects needing free hosted versioned documentation and teams wanting docs rebuilt automatically on every commit are not what MkDocs is typically brought in for.
- What can Read the Docs do that MkDocs cannot?
- Read the Docs covers Build on commit, Version by branch and tag, Pull request previews, Free for open source. MkDocs covers Plain Markdown, Single YAML config, Material theme, Live preview.
Answered from the vendors’ own pages
Read the Docs: Is Read the Docs free?
Free for open-source public projects. Private documentation requires a paid business plan.
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: What does it build from?
Most commonly Sphinx or MkDocs sources kept in your repository.
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: How does versioning work?
It maps branches and tags to documentation versions, so several releases are served side by side without manual work.
MkDocs: Does MkDocs support versioned docs?
Not natively. Plugins such as mike add it, where Docusaurus includes versioning in core.