This repository contains a self-contained JavaScript client that will empower your docs, elevating them to the next level 🚀. All these features are enabled by default just by hosting your documentation in Read the Docs.
It uses the Read the Docs analytics backend to track page views and searches performed in your documentation.
| Traffic analytics | Search analytics |
|---|---|
 |
 |
| Documentation | Documentation |
Shows PR changes embeded on the documentation pages themselves.
Shows a banner at the top of the documentation communicating the build was performed from a Pull Request.
Authentic Read the Docs' flyout that shows all the available versions, links to download the offline formats, view and edit on GitHub and more.
Shows a banner at the top telling readers they are not reading the latest stable version of the documentation.
Super powered search as you type using the Read the Docs's Server Side Search backend, powered by Elasticsearch.
EthicalAds to support Read the Docs Community being free for everybody.
Display a nice tooltip when hovering internal links of the same documentation.
Note: This work is under active development and is still in alpha.