- Enable DocDiff via a query string (
readthedocs-diff=true)
- Don't show notification on default version
- Improvements to Links Preview (using a default CSS selector and heuristic to detect the documentation tool)
- Use new API field names for File Tree Diff
- Detect embedded frame and skip loading addons
- New
CustomScript addon
- Remove check for old integration
- Don't show Ethical Ads on 404 pages
- New addon: Link Preview; preview the content of the site without navigating to it
- New addon: File Tree Diff; show all the changed files compared to the latest version
- Allow to disable
latest and/or non-stable notification independently
- Small CSS fix for filter titles
- Update all
npm dependencies with with ncu -u
- Show only logo on flyout when collapsed and logo + wordmark when expanded
- Include the language of the documentation in the collapsed version of the flyout
- Ad is more integrated on Sphinx's furo theme
- Add CSS style for CTA button on ads
- Stay on the same page when switching version from the notification
- Do not render search filters if they are empty
- Fix links to the new dashboard
- Disable some specific addons on 404 pages
- Use toast notification (displayed at top right) as default
- Remove global Read the Docs Google Analytics
- Update all
npm dependencies with with ncu -u
- Fix recent search that was shown/hidden while typing
- Don't show
true when showing recent search
- Update all
npm dependencies with with ncu -u
- Recent searches respect different domains, project, version and language
- Improve experience when moving between search result items with keyboard
- Update all
npm dependencies with with ncu -u
- Do not add UTM parameters to "Download" links in the flyout
- Add link to addons documentation in the flyout
- Update all
npm dependencies with with ncu -u
- Dismiss notifications permanently for the same project/language/version
- Add CSS variables to allow user customizations
- Update all
npm dependencies with with ncu -u
- Show paid ads on community documentation (instead of "Coming soon" ad)
- Use
data-ea-publisher attribute to detect ad placement
- Update all
npm dependencies with with ncu -u
- Small fixes to EthicalAds stickybox placement
- Typo in EthicalAds selector
- Link to
app.readthedocs.org from the flyout to promote the new dashboard more
- Collapse flyout when clicking outside (this was a regression)
- Re-enable EthicalAds on all projects with an improved logic
(inject them on specific placement or known placement, otherwise stickybox only on wide screens)
- Revert rollout of EthicalAd on projects
- Update CSS selector for EthicalAd position in Material for MkDocs
- Update all
npm dependencies with with ncu -u
- Link to
beta.readthedocs.org dashboard from notification
- Enable EthicalAds in all projects with a house ad ("Coming soon")
- Always send keywords, campaing and publisher to EthicalAds server
- Set
data-ea-placement only when the flyout is enabled
- Add UTM analytics parameters to links from the flyout
- Update all
npm dependencies with with ncu -u
- EthicalAd injected on
docs.readthedocs.io
- Search hotkey works after open/close it
- Privacy policy removed from flyout
- Update all
npm dependencies with with ncu -u
- Notification linking to stable version respects
project.versioning_scheme
- Expose endpoint response data via a JavaScript
CustomEvent called readthedocs-addons-data-ready
- Use
api-version=1 when hitting /_/addons/ backend endpoint
- Update all
npm dependencies with with ncu -u
- Change how
visualDomDiff is imported to make it compatible between testing
and production environments
- Hide flyout when triggering the search modal from the flyout input
- Close the search modal when clicking on a result
- Allow users to define a custom
rootSelector for docdiff
- Initial implementation for recent searches when opening the search modal
- Update all
npm dependencies with with ncu -u
- Flyout links keeps the page when switching versions/languages
- Update all
npm dependencies with with ncu -u
- Fix the flyout
code-branch icon position
- Update all
npm dependencies with with ncu -u
- Replace the
v: in the flyout for a code-branch icon
- Don't loose page position when closing notifications
- Improve search modal UI design
- Surround with
<strong> the selected language in the flyout
- Skip pageviews analytics on external versions
- Update all
npm dependencies with with ncu -u
- Log debug data about validation when running the client in production
- Allow projects with
multiple_versions_without_translations to show the flyout
- Security fix, more information in GHSA-9v45-336h-5xw5.
- Update all
npm dependencies with with ncu -u
- Don't show search input on flyout when search is disabled
- Update all
npm dependencies with with ncu -u
- Fix issue with
IS_TESTING variable that made the production javascript to
hit localhost: for the JSON response instead of production API.
- Customize flyout font size via CSS variables
- NPM packages updated to their latest versions
- Use JSON schema to validate data from the API
- Increase test suite for all the addons.
Test running inside the browser, checks for HTML and DOM changes,
mocked requests and more!
- Read
version_schema field instead single_version from addons API response.
- Make flyout header sticky when there are many versions
- NodeJS packages updated
- Show notification only if
stable version is available (bugfix in logic)
- Typos on notification
- NodeJS packages updated
- Show non-stable notification only if
stable is enabled
- Fix issue shown on JS console for global Read the Docs analytics
- Handle
/ keyboard shortcut properly when inside on an input
- Use
objectPath on DocDiff addon to protect ourselves on isEnabled
- Grab
project-slug= and version-slug= from meta HTML tags and send them to the API.
- Update all the NPM package dependencies
- Update
pre-commit configuration
- Update all the NPM package dependencies
- Don't show "Versions" section in flyout if the project is single version
- Make notification style better on mobile
- Don't show notification on single version projects
- Don't show version name on closed flyout when project is single version
- Use
bumpver to update version on src/utils.js
- Move HTTP header on requests to API endpoint to GET attribute
- Switch to
web-test-runner to run tests
- Add support for scrolling vertically the flyout when there are too many versions
- Collapse flyout when clicking outside of it
- Change warning notification logic to show a notification on
latest and non-stable versions
- Trigger search addon from flyout input
- Focus search input in the modal immediately after showing it
- New addons: hotkeys
- Migrate search hotkeys to be managed by the new hotkeys addon.
This is the initial published version.
Users can access to the addon features by using Read the Docs' config key build.commands.
See https://docs.readthedocs.io/en/latest/build-customization.html