🦸 Read the Docs Addons

JavaScript client injected into documentation pages served at Read the Docs. This client allows projects to quickly integrate with all the nice features that Read the Docs offers.

Examples

We maintain a list of examples to check our JavaScript client is working correctly:

Make links to point to development instance

• Antora

• Asciidoctor

• D2L-Book

• Docsify

• Docusaurus

• Jekyll

• Jupyter Book

• mdBook

• MkDocs

• MkDocs (Material theme)

• MkDocs (Terminal theme)

• Pelican

• Piccolo

• Sphinx (Alabaster theme)

• Sphinx (Awesome theme)

• Sphinx (Furo theme)

• Sphinx (Immaterial theme)

• Sphinx (PyData theme)

• Sphinx (Read the Docs theme)

• Sphinx (Shibuya theme)

• VitePress

• Zensical

Contents

• Testing
  • localhost
  • Read the Docs