@intlayer/docs 5.7.8 → 5.8.0

package/docs/ru/configuration.md

@@ -124,7 +124,6 @@ module.exports = config;
 #### Свойства
 
 - **locales**:
-
   - _Тип_: `string[]`
   - _По умолчанию_: `['en']`
   - _Описание_: Список поддерживаемых локалей в приложении.
@@ -138,7 +137,6 @@ module.exports = config;
   - _Примечание_: Если пусто, все локали обязательны в режиме `strict`.
   - _Примечание_: Убедитесь, что обязательные локали также определены в поле `locales`.
 - **strictMode**:
-
   - _Тип_: `string`
   - _По умолчанию_: `inclusive`
   - _Описание_: Обеспечивает строгую реализацию интернационализированного контента с использованием TypeScript.
@@ -147,7 +145,6 @@ module.exports = config;
   - _Примечание_: Если установлено значение "loose", функция перевода `t` примет любую существующую локаль.
 
 - **defaultLocale**:
-
   - _Тип_: `string`
   - _По умолчанию_: `'en'`
   - _Описание_: Локаль по умолчанию, используемая в качестве резервной, если запрашиваемая локаль не найдена.
@@ -163,7 +160,6 @@ module.exports = config;
 #### Свойства
 
 - **applicationURL**:
-
   - _Тип_: `string`
   - _По умолчанию_: `http://localhost:3000`
   - _Описание_: URL приложения. Используется для ограничения происхождения редактора в целях безопасности.
@@ -174,13 +170,11 @@ module.exports = config;
   - _Примечание_: URL приложения. Используется для ограничения происхождения редактора в целях безопасности. Если установлено значение `'*'`, редактор доступен с любого источника.
 
 - **port**:
-
   - _Тип_: `number`
   - _По умолчанию_: `8000`
   - _Описание_: Порт, используемый сервером визуального редактора.
 
 - **editorURL**:
-
   - _Тип_: `string`
   - _По умолчанию_: `'http://localhost:8000'`
   - _Описание_: URL сервера редактора. Используется для ограничения происхождения редактора в целях безопасности.
@@ -190,7 +184,6 @@ module.exports = config;
   - _Примечание_: URL сервера редактора для доступа из приложения. Используется для ограничения источников, которые могут взаимодействовать с приложением в целях безопасности. Если установлено значение `'*'`, редактор доступен с любого источника. Должно быть установлено, если порт изменен или если редактор размещен на другом домене.
 
 - **cmsURL**:
-
   - _Тип_: `string`
   - _По умолчанию_: `'https://intlayer.org'`
   - _Описание_: URL CMS Intlayer.
@@ -198,22 +191,19 @@ module.exports = config;
   - _Примечание_: URL CMS Intlayer.
 
 - **backendURL**:
-
   - _Тип_: `string`
   - _По умолчанию_: `https://back.intlayer.org`
   - _Описание_: URL сервера backend.
   - _Пример_: `http://localhost:4000`
 
 - **enabled**:
-
   - _Тип_: `boolean`
   - _По умолчанию_: `true`
   - _Описание_: Указывает, взаимодействует ли приложение с визуальным редактором.
   - _Пример_: `process.env.NODE_ENV !== 'production'`
-  - _Примечание_: Если true, редактор сможет взаимодействовать с приложением. Если false, редактор не сможет взаимодействовать с приложением. В любом случае редактор может быть включен только визуальным редактором. Отключение редактора для определенных сред — это способ обеспечения безопасности.
+  - _Примечание_: Если true, редактор сможет взаимодействовать с приложением. Если false, редактор не сможет взаимодействовать с приложением. В любом случае редактор может быть включен только визуальным редактором. Отключение редактора для определенных сред - это способ обеспечения безопасности.
 
 - **clientId**:
-
   - _Тип_: `string` | `undefined`
   - _По умолчанию_: `undefined`
   - _Описание_: clientId и clientSecret позволяют пакетам intlayer аутентифицироваться с backend с использованием аутентификации oAuth2. Токен доступа используется для аутентификации пользователя, связанного с проектом. Чтобы получить токен доступа, перейдите на https://intlayer.org/dashboard/project и создайте учетную запись.
@@ -221,7 +211,6 @@ module.exports = config;
   - _Примечание_: Важно: clientId и clientSecret должны храниться в секрете и не должны быть общедоступными. Убедитесь, что они хранятся в безопасном месте, например, в переменных окружения.
 
 - **clientSecret**:
-
   - _Тип_: `string` | `undefined`
   - _По умолчанию_: `undefined`
   - _Описание_: clientId и clientSecret позволяют пакетам Intlayer аутентифицироваться с backend с использованием аутентификации oAuth2. Токен доступа используется для аутентификации пользователя, связанного с проектом. Чтобы получить токен доступа, перейдите на https://intlayer.org/dashboard/project и создайте учетную запись.
@@ -229,7 +218,6 @@ module.exports = config;
   - _Примечание_: Важно: clientId и clientSecret должны храниться в секрете и не должны быть общедоступными. Убедитесь, что они хранятся в безопасном месте, например, в переменных окружения.
 
 - **hotReload**:
-
   - _Тип_: `boolean`
   - _По умолчанию_: `false`
   - _Описание_: Указывает, должно ли приложение автоматически обновлять конфигурации локалей при обнаружении изменений.
@@ -250,7 +238,6 @@ module.exports = config;
 #### Свойства
 
 - **headerName**:
-
   - _Тип_: `string`
   - _По умолчанию_: `'x-intlayer-locale'`
   - _Описание_: Имя HTTP-заголовка, используемого для определения локали.
@@ -258,7 +245,6 @@ module.exports = config;
   - _Примечание_: Это полезно для определения локали на основе API.
 
 - **cookieName**:
-
   - _Тип_: `string`
   - _По умолчанию_: `'intlayer-locale'`
   - _Описание_: Имя cookie, используемого для хранения локали.
@@ -266,7 +252,6 @@ module.exports = config;
   - _Примечание_: Используется для сохранения локали между сессиями.
 
 - **prefixDefault**:
-
   - _Тип_: `boolean`
   - _По умолчанию_: `false`
   - _Описание_: Включать ли локаль по умолчанию в URL.
@@ -276,7 +261,6 @@ module.exports = config;
     - Если `false` и `defaultLocale = 'en'`: path = `/dashboard` или `/fr/dashboard`
 
 - **basePath**:
-
   - _Тип_: `string`
   - _По умолчанию_: `''`
   - _Описание_: Базовый путь для URL приложения.
@@ -288,7 +272,6 @@ module.exports = config;
     - Если базовый путь не установлен, URL будет `https://example.com/en`
 
 - **serverSetCookie**:
-
   - _Тип_: `string`
   - _По умолчанию_: `'always'`
   - _Описание_: Правило для установки cookie локали на сервере.
@@ -297,7 +280,6 @@ module.exports = config;
   - _Примечание_: Управляет, устанавливается ли cookie локали при каждом запросе или никогда.
 
 - **noPrefix**:
-
   - _Тип_: `boolean`
   - _По умолчанию_: `false`
   - _Описание_: Исключать ли префикс локали из URL.
@@ -310,7 +292,6 @@ module.exports = config;
       - Если `noPrefix = true`: URL будет `https://example.com`
 
 - **detectLocaleOnPrefetchNoPrefix**:
-
   - _Тип_: `boolean`
   - _По умолчанию_: `false`
   - _Описание_: Управляет, происходит ли обнаружение локали во время запросов предварительной загрузки Next.js.
@@ -343,13 +324,11 @@ module.exports = config;
 #### Свойства
 
 - **watch**:
-
   - _Тип_: `boolean`
   - _По умолчанию_: `process.env.NODE_ENV === 'development'`
   - _Описание_: Указывает, должен ли Intlayer отслеживать изменения в файлах декларации контента в приложении для пересборки связанных словарей.
 
 - **fileExtensions**:
-
   - _Тип_: `string[]`
   - _По умолчанию_: `['.content.ts', '.content.js', '.content.cjs', '.content.mjs', '.content.json', '.content.tsx', '.content.jsx']`
   - _Описание_: Расширения файлов, которые нужно искать при построении словарей.
@@ -357,7 +336,6 @@ module.exports = config;
   - _Примечание_: Настройка расширений файлов может помочь избежать конфликтов.
 
 - **baseDir**:
-
   - _Тип_: `string`
   - _По умолчанию_: `process.cwd()`
   - _Описание_: Базовая директория для проекта.
@@ -365,26 +343,22 @@ module.exports = config;
   - _Примечание_: Используется для разрешения всех связанных с Intlayer директорий.
 
 - **dictionaryOutput**:
-
   - _Тип_: `string[]`
   - _По умолчанию_: `['intlayer']`
   - _Описание_: Тип вывода словаря, например, `'intlayer'` или `'i18next'`.
 
 - **contentDir**:
-
   - _Тип_: `string[]`
   - _По умолчанию_: `['src']`
   - _Пример_: `['src', '../../ui-library', require.resolve("@my-package/content")]`
   - _Описание_: Путь к директории, где хранится контент.
 
 - **dictionariesDir**:
-
   - _Тип_: `string`
   - _По умолчанию_: `'.intlayer/dictionaries'`
   - _Описание_: Путь к директории для хранения промежуточных или выходных результатов.
 
 - **moduleAugmentationDir**:
-
   - _Тип_: `string`
   - _По умолчанию_: `'.intlayer/types'`
   - _Описание_: Директория для расширения модулей, что позволяет улучшить подсказки IDE и проверку типов.
@@ -392,21 +366,18 @@ module.exports = config;
   - _Примечание_: Обязательно включите эту директорию в `tsconfig.json`.
 
 - **unmergedDictionariesDir**:
-
   - _Тип_: `string`
   - _По умолчанию_: `'.intlayer/unmerged_dictionary'`
   - _Описание_: Директория для хранения несмёрженных словарей.
   - _Пример_: `'translations'`
 
 - **dictionariesDir**:
-
   - _Тип_: `string`
   - _По умолчанию_: `'.intlayer/dictionary'`
   - _Описание_: Директория для хранения словарей локализации.
   - _Пример_: `'translations'`
 
 - **i18nextResourcesDir**:
-
   - _Тип_: `string`
   - _По умолчанию_: `'i18next_dictionary'`
   - _Описание_: Директория для хранения словарей i18n.
@@ -414,14 +385,12 @@ module.exports = config;
   - _Примечание_: Убедитесь, что эта директория настроена для типа вывода i18next.
 
 - **typesDir**:
-
   - _Тип_: `string`
   - _По умолчанию_: `'types'`
   - _Описание_: Директория для хранения типов словарей.
   - _Пример_: `'intlayer-types'`
 
 - **mainDir**:
-
   - _Тип_: `string`
   - _По умолчанию_: `'main'`
   - _Описание_: Директория, где хранятся основные файлы приложения.
@@ -440,7 +409,6 @@ module.exports = config;
 #### Свойства
 
 - **mode**:
-
   - _Тип_: `string`
   - _По умолчанию_: `default`
   - _Описание_: Указывает режим работы логгера.
@@ -449,7 +417,6 @@ module.exports = config;
   - _Примечание_: Режим логгера. Режим verbose будет выводить больше информации, но может использоваться для отладки. Режим disabled отключает логгер.
 
 - **prefix**:
-
   - _Тип_: `string`
   - _По умолчанию_: `'[intlayer] '`
   - _Описание_: Префикс логгера.
@@ -474,7 +441,6 @@ Intlayer поддерживает нескольких провайдеров AI
 #### Свойства
 
 - **provider**:
-
   - _Тип_: `string`
   - _По умолчанию_: `'openai'`
   - _Описание_: Провайдер, используемый для функций AI в Intlayer.
@@ -483,7 +449,6 @@ Intlayer поддерживает нескольких провайдеров AI
   - _Примечание_: Разные провайдеры могут требовать разные API-ключи и иметь разные модели ценообразования.
 
 - **model**:
-
   - _Тип_: `string`
   - _По умолчанию_: Нет
   - _Описание_: Модель, используемая для функций AI в Intlayer.
@@ -491,7 +456,6 @@ Intlayer поддерживает нескольких провайдеров AI
   - _Примечание_: Конкретная модель зависит от провайдера.
 
 - **temperature**:
-
   - _Тип_: `number`
   - _По умолчанию_: Нет
   - _Описание_: Температура контролирует случайность ответов AI.
@@ -499,7 +463,6 @@ Intlayer поддерживает нескольких провайдеров AI
   - _Примечание_: Более высокая температура делает AI более креативным и менее предсказуемым.
 
 - **apiKey**:
-
   - _Тип_: `string`
   - _По умолчанию_: Нет
   - _Описание_: Ваш API-ключ для выбранного провайдера.
@@ -524,7 +487,6 @@ Intlayer поддерживает нескольких провайдеров AI
 #### Свойства
 
 - **optimize**:
-
   - _Тип_: `boolean`
   - _По умолчанию_: `process.env.NODE_ENV === 'production'`
   - _Описание_: Контролирует, должна ли быть оптимизирована сборка.
@@ -535,7 +497,6 @@ Intlayer поддерживает нескольких провайдеров AI
   - _Примечание_: Убедитесь, что все ключи объявлены статически в вызовах `useIntlayer`. например: `useIntlayer('navbar')`.
 
 - **importMode**:
-
   - _Тип_: `'static' | 'dynamic' | 'async'`
   - _По умолчанию_: `'static'`
   - _Описание_: Контролирует, как импортируются словари.