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 may be reading an outdated version.
Shows a banner at the top telling readers they are reading the latest un-released 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.
- Make sure you have the correct version of Node.js installed (>= 18). You can use asdf or nvm for easier management of different Node.js versions.
- Run
npm installto install dependencies - Run
npm run devto start the local dev server. While this can run without a local Read the Docs development instance, not everything will work. - Run
npm testto run the test suite, using web-test-runner. You can run alsonpm run test:devto leave tests running in watch mode ornpm run test:debugto manually test the suite in a browser.
Note: This work is under active development and is still in alpha.