@sanity/document-internationalization v3.0.0

Document Internationalization Plugin for Sanity.io

What this plugin solves

There are two popular methods of internationalization in Sanity Studio:

• Document-level translation refers to a schema type having a unique document for every language, joined together by references and/or a predictable _id
• Field-level translation refers to mapping over languages to create an object, within which there is a language-specific version of each field

You'll need to decide on the approach for each schema individually, and you're likely going to have a mix of both.

This plugin adds UI to the Studio to improve handling document-level translations.

For field-level translations you should use the @sanity/language-filter plugin.

Installation

With the Sanity CLI installed, from the same directory as the Studio run:

sanity install @sanity/document-internationalization

Ensure that @sanity/document-internationalization is listed in plugins inside sanity.json.

The plugin is now installed, but you will need to complete the following steps to see the Document Translation UI:

Setup next steps

1. Customise Desk Structure
   To setup the 'Translations' View Pane on Documents
2. Configuration options
   To declare available Languages and other settings
3. Activating internationalization on schema
   To enable all the above features on schema

Other documentation

1. Data structure
2. Translation Maintenance
3. GraphQL support
4. Advanced languages
5. Usage with custom publish action
6. GROQ Cheatsheet

Migrating from sanity-plugin-intl-input

While most of the UI is the same in the official version of this plugin there are some breaking changes you should be aware of before migrating:

Coming from sanity-plugin-intl-input