Today, we officially release Docusaurus 2 i18n (internationalization), as part of 2.0.0-alpha.71.
Docusaurus 2 has now reached full feature parity with Docusaurus 1. 🎉 And soon, after a few additional infrastructure updates and a bit more testing, the first Docusaurus 2 beta will be released.
We went the extra mile, and the new i18n support is even better than in Docusaurus 1.
In this post, we will present you the translation workflow, explain some design decisions and showcase early adopter sites that just went live: Jest, Redwood, and Datagit.
We also dogfood the i18n support on the Docusaurus 2 site itself, and this post is already available in English and French!
Translate your site
You can translate a Docusaurus site in 3 simple steps:
- Configure: declare the default locale and alternative locales in
docusaurus.config.js - Translate: put the translation files at the correct filesystem location
- Deploy: build and deploy your site using a single or multi-domain strategy
The i18n support is very flexible and based on the filesystem.
The i18n tutorial is the best way to get started, and we provide help to use Git or Crowdin.
Design decisions
The goals of the Docusaurus i18n system are:
- Simple: just put the translated files in the correct filesystem location
- Flexible translation workflows: use Git (monorepo, forks, or submodules), SaaS software, FTP
- Flexible deployment options: single, multiple domains, or hybrid
- Modular: allow plugin authors to provide i18n support
- Low-overhead runtime: documentation is mostly static and does not require a heavy JS library or polyfills
- Scalable build-times: allow building and deploying localized sites independently
- Localize assets: an image of your site might contain text that should be translated
- No coupling: not forced to use any SaaS, yet integrations are possible
- Easy to use with Crowdin: multiple Docusaurus 1 sites use Crowdin, and should be able to migrate to v2
- Good SEO defaults: we set useful SEO headers like
hreflangfor you - RTL support: locales reading right-to-left (Arabic, Hebrew, etc.) are supported and easy to implement
- Default translations: classic theme labels are translated for you in many languages
Showcase
We worked with a few volunteers to dogfood the i18n support before releasing it.
Jest: upgrading Docusaurus
We have made it possible to upgrade a translated Docusaurus 1 site to Docusaurus 2.
Jest, using Docusaurus 1 and Crowdin was one of those sites.
The Docusaurus 2 migration was successful and the new site is now deployed in production (announcement post).
Redwood: adopting Docusaurus
Redwood is a React full-stack Jamstack framework.
They were looking for a solution to create an internationalized learning platform, and became early adopters of Docusaurus 2 i18n for learn.redwoodjs.com, using Crowdin to get it translated to French.
Datagit: using LTR support
The i18n system should work with any language, including Right-to-Left languages.
Datagit.ir is using Farsi, and a simple configuration option is able to flip the Docusaurus theme to add the required Right-to-Left support.
Conclusion
We sincerely hope you will adopt and like the new i18n support.
This feature has not been an easy one, and we would like to thank everyone that got involved in this journey:
- Alexey for his help to make the i18n support exhaustive and even better than v1
- Simen for volunteering and supporting the Jest migration
- Claire for adopting Docusaurus 2 on the new Redwood platform and providing many feedbacks
- Massoud for reviewing my work on LTR and adopting it on Datagit
- Crowdin for their support and willingness to improve their translation SaaS
- The Docusaurus community for their patience, and providing many useful feedbacks on GitHub
Thanks for reading.
🙏 And please, add your brand new i18n sites to our showcase page. We accept any all polished Docusaurus site here, and we are working on a redesign allowing you to filter sites by features.