Give your documentation readers a great experience

Documentation UX is as important as the content itself. Give your readers a number of in-documentation features that they'll love.

Easily find content with great search
Allow users to browser docs for the exact version they're using
Alert users who are using old versions
Easily download docs before their flight

Read the Docs is the "all in one" solution that gives you all these features with minimal configuration.


Clearly communicate readers they are reading an outdated version of the documentation, and reduce support requests from old version of your product.

Notification on a old version

Search as you type

Always find what you are looking for at the tip of your fingers with our powerful ElasticSearch engine. Search on a single or accross multiple projects at once.

Search as you type

Offline formats

Your users might need to send documentation in an email, or read it on a plane. Offline formats like PDF and Zipped HTML are a great way to make your documentation portable. It also makes storing a full copy easy for regulatory compliance and archiving.

Offline formats

Read the Docs Flyout

Let your users select between multiple versions and translations of your documentation in a quick way using the flyout menu.

Read the Docs flyout
Try it out

Deploy in 5 minutes and see for yourself

version: 2
  os: "ubuntu-22.04"
    nodejs: "18"
    # You can also specify other tool versions:
    # python: "3"
      # "docs/" was created following the Docusaurus tutorial:
      # npx create-docusaurus@latest docs classic
      # Install Docusaurus dependencies
      - cd docs/ && npm install
      # Build the site
      - cd docs/ && npm run build
      # Copy generated files into Read the Docs directory
      - mkdir --parents $READTHEDOCS_OUTPUT/html/
      - cp --recursive docs/build/* $READTHEDOCS_OUTPUT/html/
Create an account Sign up with GitHub or your email. Import your project Select a project from your existing Git repositories. Add YAML config Save this file as .readthedocs.yaml, and update the commands as necessary. Your docs build on every commit Like magic.

Automate your docs with Read the Docs

Sign up