JSPM

  • Created
  • Published
  • Downloads 1101
  • Score
    100M100P100Q119340F
  • License MIT

DeepL provider for translate plugin in Strapi 4

Package Exports

  • strapi-provider-translate-deepl
  • strapi-provider-translate-deepl/package.json

Readme

DeepL provider for Strapi Translate Plugin

Configure the provider through the pluginOptions:

module.exports = {
  // ...
  translate: {
    enabled: true,
    config: {
      // Choose one of the available providers
      provider: 'deepl',
      // Pass credentials and other options to the provider
      providerOptions: {
        // your API key - required and wil cause errors if not provided
        apiKey: 'key',
        // use custom api url - optional
        apiUrl: 'https://api-free.deepl.com',
        // use custom locale mapping (for example 'en' locale is deprecated so need to choose between 'EN-GB' and 'EN-US')
        localeMap: {
          // use uppercase here!
          EN: 'EN-US',
        },
        // Optional: Pass glossaries on translation. The correct glossary for each translation is selected by the target_lang and source_lang properties 
        glossaries: [
          {
            id: "your-glossary-id",
            target_lang: "DE",
            source_lang: "EN",
          }
        ],
        apiOptions: {
          // see <https://github.com/DeepLcom/deepl-node#text-translation-options> for supported options.
          // note that tagHandling Mode and glossary cannot be set this way.
          // use with caution, as non-default values may break translation of markdown
          formality: 'default',
          // ...
        },
      },
      // other options ...
    },
  },
  // ...
}

or use the default environment variables:

  • DEEPL_API_KEY - default undefined
  • DEEPL_API_URL - default undefined

To get an API key, register for free at www.deepl.com/pro#developer.

Limitations: