Skip to content
Last updated

Add translated content

After preparing the structure of your project for localization, add the translated content files to your locale folders.

Before you begin

Make sure you have the following:

  • The structure of your project prepared for localization. See l10n configuration for setup information.
  • Translated content files.

Add translated content files

To add a translated Markdown file or API description file to your project, place the files in their respective locale folders inside the @l10n folder.

The relative path from the locale folder to the translated file must be the same as the relative path from the root of the project to the file in the default language. For example, if you originally had a file with path ./index.md, the file translated to Spanish must be located in ./@l10n/es-ES/index.md, as in the following example:

Example file structure for localized content
your-awesome-project/
├──@l10n/
│   ├──es-ES/
│   │   ├──images/
│   │   ├──index.md
│   │   └──openapi.yaml
│   ├──es-419/
│   │   ├──images/
│   │   ├──index.md
│   │   └──openapi.yaml
│   ├──fr/
│   │   ├──images/
│   │   ├──index.md
│   │   └──openapi.yaml
│   ├──ja/
│   │   ├──images/
│   │   ├──index.md
│   │   └──openapi.yaml
│   ├──zh-Hans/
│   │   ├──images/
│   │   ├──index.md
│   │   └──openapi.yaml
│   └──zh-Hant/
│       ├──images/
│       └──openapi.yaml
│       ├──index.md
├──images/
├──index.md
├──openapi.yaml
└──redocly.yaml

Localize partial content

You can localize content you include in partials, or reusable content files pulled into multiple files using a partial Markdoc tag.

To localize content in partials:

  1. Add a folder with the same name as your partials folder to each of your locale folders.
  2. Place the translated content in each of the partials folders.
Example folder structure for localizing partials
your-awesome-project/
├──_partials/
├──@l10n/
│   ├──es-ES/
│   │   ├──_partials/
│   │   ├──images/
│   │   ├──index.md
│   │   └──openapi.yaml
│ ...
├──images/
├──index.md
├──openapi.yaml
└──redocly.yaml

Resources

  • Localization configuration - Configure language support, default locales, and localization behavior for your multi-language project
  • Localize UI labels - Translate interface labels and UI text using translation keys for consistent multi-language user experience
 
Next page