https://github.com/futuremind/strapi-provider-translate-deepl

https://github.com/futuremind/strapi-provider-translate-deepl

Last synced: 12 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/futuremind/strapi-provider-translate-deepl
• Owner: FutureMind
• License: mit
• Created: 2024-10-02T12:40:34.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-18T06:23:00.000Z (over 1 year ago)
• Last Synced: 2025-05-16T10:12:47.438Z (about 1 year ago)
• Language: JavaScript
• Size: 12.7 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# DeepL provider for Strapi Translate Plugin

Configure the provider through the pluginOptions:

```js

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',

        },

        apiOptions: {

          // see  for supported options.

          // note that tagHandling Mode 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](https://www.deepl.com/pro#developer).

## Limitations:

- Only the [deepl supported languages](https://www.deepl.com/docs-api/translating-text/request/) can be translated

- The API-Limits of DeepL ([size](https://www.deepl.com/de/docs-api/accessing-the-api/limits/), [number of fields](https://www.deepl.com/de/docs-api/translating-text/request/)) and [too many requests](https://www.deepl.com/de/docs-api/api-access/error-handling/) should be respected. If one field is larger than the request size limit, the content needs to be split and merged at some character, which may break the content layout!