Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/readthedocs/addons

JavaScript client to integrate with Read the Docs nicely
https://github.com/readthedocs/addons

addons read-the-docs

Last synced: 4 days ago
JSON representation

JavaScript client to integrate with Read the Docs nicely

Host: GitHub
URL: https://github.com/readthedocs/addons
Owner: readthedocs
License: mit
Created: 2023-03-11T18:19:35.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-10-29T09:46:48.000Z (15 days ago)
Last Synced: 2024-10-29T11:48:08.449Z (15 days ago)
Topics: addons, read-the-docs
Language: JavaScript
Homepage: https://readthedocs-addons.readthedocs.io/
Size: 18.7 MB
Stars: 21
Watchers: 6
Forks: 4
Open Issues: 64
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

# Empower your docs with Read the Docs

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.

## Features

### Analytics

It uses the [Read the Docs analytics backend](https://docs.readthedocs.io/page/reference/analytics.html) to track page views and searches performed in your documentation.

| Traffic analytics | Search analytics |
| ---------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| ![Traffic analytics](docs/traffic-analytics-example.png) | ![Search analytics](docs/search-analytics-example.png) |
| [Documentation](https://docs.readthedocs.io/page/analytics.html) | [Documentation](https://docs.readthedocs.io/page/guides/search-analytics.html) |

### Docdiff

Shows PR changes embeded on the documentation pages themselves.

![Docdiff example](docs/docdiff-example.png)

### PR warning banner

Shows a banner at the top of the documentation communicating the build was performed from a Pull Request.

![PR warning banner](docs/pr-warning-banner-example.png)

### Flyout

_Authentic_ Read the Docs' flyout that shows all the available versions,
links to download the offline formats, view and edit on GitHub and more.

![Flyout](docs/flyout-example.png)

### Non-stable version warning banner

Shows a banner at the top telling readers they may be reading an outdated version.

![Non-stable version warining banner](docs/non-stable-warning-banner-example.png)

### Latest version warning banner

Shows a banner at the top telling readers they are reading the latest un-released version of the documentation.

![Latest version warning banner](docs/latest-warning-banner-example.png)

### Search as you type

Super powered search as you type using the [Read the Docs's Server Side Search backend](https://docs.readthedocs.io/page/server-side-search/api.html),
powered by Elasticsearch.

![Search as you type](docs/search-as-you-type-example.gif)

### Sponsorship

[EthicalAds](https://www.ethicalads.io/) to support Read the Docs Community being free for everybody.

![EthicalAds](docs/ethical-ads-example.png)

---

## Local Development

- Make sure you have the correct version of Node.js installed (>= 18). You can use [asdf](https://github.com/asdf-vm/asdf) or [nvm](https://github.com/nvm-sh/nvm) for easier management of different Node.js versions.
- Run `npm install` to install dependencies
- Run `npm run dev` to start the local dev server. While this can run without a local Read the Docs development instance, not everything will work.
- Run `npm test` to run the test suite, using web-test-runner. You can run also `npm run test:dev` to leave tests running in watch mode or `npm run test:debug` to manually test the suite in a browser.

## Deployment

Deploy documentation is available in our published docs here: https://readthedocs-addons.readthedocs.io/releasing.html