{"id":19111449,"url":"https://github.com/readthedocs/addons","last_synced_at":"2026-02-04T04:09:53.626Z","repository":{"id":142926667,"uuid":"612703474","full_name":"readthedocs/addons","owner":"readthedocs","description":"JavaScript client to integrate with Read the Docs nicely","archived":false,"fork":false,"pushed_at":"2026-02-02T10:49:14.000Z","size":33513,"stargazers_count":42,"open_issues_count":78,"forks_count":21,"subscribers_count":7,"default_branch":"main","last_synced_at":"2026-02-02T22:35:29.404Z","etag":null,"topics":["addons","read-the-docs"],"latest_commit_sha":null,"homepage":"https://readthedocs-addons.readthedocs.io/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/readthedocs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-03-11T18:19:35.000Z","updated_at":"2026-02-02T10:49:17.000Z","dependencies_parsed_at":"2025-12-09T20:11:41.477Z","dependency_job_id":null,"html_url":"https://github.com/readthedocs/addons","commit_stats":null,"previous_names":["readthedocs/addons"],"tags_count":71,"template":false,"template_full_name":null,"purl":"pkg:github/readthedocs/addons","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readthedocs%2Faddons","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readthedocs%2Faddons/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readthedocs%2Faddons/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readthedocs%2Faddons/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/readthedocs","download_url":"https://codeload.github.com/readthedocs/addons/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readthedocs%2Faddons/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29067829,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-04T03:31:03.593Z","status":"ssl_error","status_checked_at":"2026-02-04T03:29:50.742Z","response_time":62,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["addons","read-the-docs"],"created_at":"2024-11-09T04:28:34.938Z","updated_at":"2026-02-04T04:09:53.609Z","avatar_url":"https://github.com/readthedocs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Empower your docs with Read the Docs\n\nThis repository contains a self-contained JavaScript client that will empower your docs,\nelevating them to the next level 🚀.\nAll these features are enabled by default _just_ by hosting your documentation in Read the Docs.\n\n## Features\n\n### Analytics\n\nIt 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.\n\n| Traffic analytics                                                | Search analytics                                                               |\n| ---------------------------------------------------------------- | ------------------------------------------------------------------------------ |\n| ![Traffic analytics](docs/traffic-analytics-example.png)         | ![Search analytics](docs/search-analytics-example.png)                         |\n| [Documentation](https://docs.readthedocs.io/page/analytics.html) | [Documentation](https://docs.readthedocs.io/page/guides/search-analytics.html) |\n\n### Docdiff\n\nShows PR changes embeded on the documentation pages themselves.\n\n![Docdiff example](docs/docdiff-example.png)\n\n### PR warning banner\n\nShows a banner at the top of the documentation communicating the build was performed from a Pull Request.\n\n![PR warning banner](docs/pr-warning-banner-example.png)\n\n### Flyout\n\n_Authentic_ Read the Docs' flyout that shows all the available versions,\nlinks to download the offline formats, view and edit on GitHub and more.\n\n![Flyout](docs/flyout-example.png)\n\n### Non-stable version warning banner\n\nShows a banner at the top telling readers they may be reading an outdated version.\n\n![Non-stable version warining banner](docs/non-stable-warning-banner-example.png)\n\n### Latest version warning banner\n\nShows a banner at the top telling readers they are reading the latest un-released version of the documentation.\n\n![Latest version warning banner](docs/latest-warning-banner-example.png)\n\n### Search as you type\n\nSuper 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),\npowered by Elasticsearch.\n\n![Search as you type](docs/search-as-you-type-example.gif)\n\n### Sponsorship\n\n[EthicalAds](https://www.ethicalads.io/) to support Read the Docs Community being free for everybody.\n\n![EthicalAds](docs/ethical-ads-example.png)\n\n---\n\n## Local Development\n\n- Make sure you have the correct version of Node.js installed (\u003e= 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.\n- Run `npm install` to install dependencies\n- 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.\n- 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.\n\n## Deployment\n\nDeploy documentation is available in our published docs here: https://readthedocs-addons.readthedocs.io/releasing.html\n\n## Development guidelines\n\n### Element attributes\n\n- Don't use CSS classes on web component elements, these have tended to conflict with parent DOM styles. If needed, use CSS selectors against web component attributes like `:host[position=\"inline\"]` instead.\n- When adding an attribute on a custom web components, don't use `data` prefixed attributes, for example `\u003creadthedocs-flyout position=\"inline\"\u003e`.\n- When using a custom attribute on a native element, do use `data` prefixed attributes, for example `\u003cdiv data-position=\"inline\"\u003e`.\n\n### CSS variables\n\nWe use CSS variables to provide end users and theme maintainers with some light control of element styling of the inner shadow DOM elements.\nVariables have several layers of prefixing/inheritance, as shown here using `font-size` as an example:\n\n- `--readthedocs-font-size`: This can be set at `html`/`:root` in the parent DOM to affect font size on all of our elements.\n- `--readthedocs-flyout-font-size`: This can be set at `html`/`:root` in the parent DOM to affect font size on only the flyout element.\n- `--addons-flyout-font-size`: This is an inner variable used by the addon shadow DOM CSS. It's set inside each addon `:host` CSS selector to give a default value to `--readthedocs-flyout-font-size` without overriding a user supplied value for this variable.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freadthedocs%2Faddons","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freadthedocs%2Faddons","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freadthedocs%2Faddons/lists"}