Read the Docs Addons
Read the Docs Addons is a group of features for documentation readers and maintainers that you can add to any documentation set hosted on Read the Docs. They are used in the rendered documentation, and can be accessed via hotkeys or on screen UI elements.
- Visual diff
Highlight changed output from pull requests
- Link previews
See the content the link points to before clicking on it
- Documentation notification
Alert users to various documentation states
- Flyout
Easily switch between versions and translations
- Non-stable notification
Notify readers that they are reading docs from a non stable release
- Latest version notification
Notify readers that they are reading docs from a development version
- Search as you type
Get search results faster
- Traffic analytics
See what pages your users are reading
- Search analytics
Understand what your users are searching for
Configuring Read the Docs Addons
Individual configuration options for each addon are available in Settings.
Go to the new dashboard:
Click on a project name.
Go to Settings
In the left bar, go to Addons.
Configure each Addon individually.
Addons data and customization
If you’d like to do a custom integration with the data used to render Addons, you can learn more about this in our Custom event integration docs.
Diving deeper
You can read more about all of the Addons functionality by diving into each Addon above. If you are a developer and would like to integrate with our Addons or use our existing data, you can reach out to us and we would love to work with you.