Logo

Getting started

  • Tutorial
  • Adding a documentation project
  • Popular documentation tools
    • Deploying Sphinx on Read the Docs
    • Deploying MkDocs on Read the Docs
    • Deploying Docusaurus on Read the Docs
    • Deploying Markdoc on Read the Docs
    • Deploying mdBook on Read the Docs
    • Deploying VitePress on Read the Docs
    • Deploying Antora on Read the Docs
    • Deploying Zensical on Read the Docs
    • Deploying MyST Markdown on Read the Docs
  • Example projects

Project setup and configuration

  • Configuration file overview
  • Configuration file reference
  • Read the Docs Addons
  • Account authentication methods
  • Automation rules
  • How to create reproducible builds

Build process

  • Build process overview
  • Build process customization
  • Git integration (GitHub, GitLab, Bitbucket)
  • Pull request previews
  • Build failure notifications
  • Environment variable overview
  • Environment variable reference

Hosting documentation

  • Versions
  • Subprojects
  • Localization and Internationalization
  • URL versioning schemes
  • Custom domains
  • URL path prefixes
  • Documentation notifications
  • Canonical URLs
  • Content Delivery Network (CDN) and caching
  • Sitemap support
  • 404 Not Found pages
  • robots.txt support
  • llms.txt support

Reading documentation

  • Offline formats (PDF, ePub, HTML)
  • Visual diff
  • Link previews
  • How to embed content from your documentation
  • Server side search
  • Search query syntax
  • Flyout menu

Maintaining projects

  • Redirects
  • Traffic analytics
  • Search analytics
  • Security logs
  • Status badges
  • How to structure your documentation
  • Best practices for linking to your documentation
  • Security considerations for documentation pages
  • Main content detection
  • AI agent skills
  • Custom script

Business features

  • Business hosting
  • Organizations
  • Single sign-on (SSO)
  • Sharing private documentation
  • How to manage your subscription
  • Privacy levels

How-to guides

  • Project setup and configuration
  • Build process
  • Upgrading and maintaining projects
  • Content, themes and SEO
  • Security and access
  • Account management
  • Best practice
  • Troubleshooting problems

Reference

  • Public REST API
  • Frequently asked questions
  • Changelog
  • About Read the Docs
  • Developer Documentation
  • Read the Docs website
Read the Docs user documentation
  • Popular documentation tools
  • Edit on GitHub

Popular documentation tools

Read the Docs provides documentation hosting for any tool that can output HTML. We provide a number of features that are well-suited to documentation specifically, but you can host any kind of HTML content on Read the Docs.

Below is a list of popular documentation tools that you can use to write your documentation.

See also

Build process customization Learn how to build documentation with any tool.

MkDocs

MkDocs is a powerful documentation tool for markdown.

Supported formats

md

Written in

python

mkdocs.html
Zensical

Zensical is a static-site generator built by the creators of Material for MkDocs.

Supported formats

md

Written in

rust python

zensical.html
Sphinx

Sphinx is a powerful documentation generator that has many features for writing technical documentation.

Supported formats

rst md

Written in

python

sphinx.html
Docusaurus

Docusaurus is a static-site generator that builds a single-page application with fast client-side navigation and out-of-the-box documentation features.

Supported formats

mdx md

Written in

React

docusaurus.html
Markdoc

Markdoc is a documentation tool developed by Stripe that allows you to write documentation in a custom Markdown flavor.

Supported formats

md

Written in

javascript

markdoc.html
mdBook

mdBook is a command line tool to create books with Markdown built in Rust.

Supported formats

md

Written in

rust

mdbook.html
VitePress

VitePress is a static site generator with a focus on performance and simplicity.

Supported formats

md

Written in

typescript

vitepress.html
Antora

Antora is a static site generator for creating documentation sites from AsciiDoc content.

Supported formats

adoc

Written in

javascript

antora.html
MyST Markdown

MyST Markdown is a powerful authoring framework for scientific communication including blogs, books, papers, and articles.

Supported formats

md ipynb

Written in

javascript

mystmd.html
Previous Next

© Copyright Read the Docs, Inc & contributors.

Built with Sphinx using a theme provided by Read the Docs.

Build your docs with Read the Docs

Community

Free documentation hosting for open source projects on readthedocs.org.

Sign up Log in

Business

Private docs and team features for commercial projects on readthedocs.com.

Sign up Log in