Docusaurus has a canary releases system.
It permits you to test new unreleased features as soon as the pull-requests are merged.
It is a good way to give feedback to maintainers, ensuring the newly implemented feature works as intended.
Using a canary release in production might seem risky, but in practice it's not.
A canary release passes all automated tests, and is used in production by the Docusaurus site itself.
For any code-related commit on
main, the continuous integration will publish a canary release under the
@canary npm dist tag. It generally takes up to 10 minutes.
You can see on npm the current dist tags:
latest: stable releases (example:
canary: canary releases (example:
Make sure to use the latest canary release and check the publication date (sometimes the publish process fails).
Canary versions follow the naming convention
Take the latest version published under the canary npm dist tag (for example:
Use it for all the
@docusaurus/* dependencies in your
- "@docusaurus/core": "^2.0.0-beta.0",- "@docusaurus/preset-classic": "^2.0.0-beta.0",+ "@docusaurus/core": "0.0.0-1234+4a6de5cf7",+ "@docusaurus/preset-classic": "0.0.0-1234+4a6de5cf7",
Then, install the dependencies again and start your site:
npm installnpm start
You can also upgrade the
@docusaurus/* packages with a command line:
npm install --save-exact @docusaurus/core@canary @docusaurus/preset-classic@canary
Make sure to include all the
For canary releases, prefer using an exact version instead of a semver range (avoid the