@intlayer/docs 5.5.8

package/ru/intlayer_cli.md

@@ -0,0 +1,274 @@
+# Intlayer CLI
+
+## Установка пакета
+
+Установите необходимые пакеты с помощью npm:
+
+```bash packageManager="npm"
+npm install intlayer-cli -g
+```
+
+```bash packageManager="yarn"
+yarn add intlayer-cli -g
+```
+
+```bash packageManager="pnpm"
+pnpm add intlayer-cli -g
+```
+
+> Если пакет `intlayer` уже установлен, CLI устанавливается автоматически. Этот шаг можно пропустить.
+
+## Пакет intlayer-cli
+
+Пакет `intlayer-cli` предназначен для транспиляции ваших [объявлений intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/ru/dictionary/get_started.md) в словари.
+
+Этот пакет транспилирует все файлы intlayer, такие как `src/**/*.content.{ts|js|mjs|cjs|json}`. [Смотрите, как объявлять файлы деклараций Intlayer](https://github.com/aymericzip/intlayer/blob/main/packages/intlayer/README.md).
+
+Для интерпретации словарей intlayer вы можете использовать интерпретаторы, такие как [react-intlayer](https://www.npmjs.com/package/react-intlayer) или [next-intlayer](https://www.npmjs.com/package/next-intlayer).
+
+## Поддержка конфигурационных файлов
+
+Intlayer поддерживает несколько форматов конфигурационных файлов:
+
+- `intlayer.config.ts`
+- `intlayer.config.js`
+- `intlayer.config.json`
+- `intlayer.config.cjs`
+- `intlayer.config.mjs`
+- `.intlayerrc`
+
+Чтобы узнать, как настроить доступные локали или другие параметры, обратитесь к [документации по конфигурации здесь](https://github.com/aymericzip/intlayer/blob/main/docs/ru/configuration.md).
+
+## Запуск команд intlayer
+
+### Сборка словарей
+
+Для сборки ваших словарей вы можете выполнить команды:
+
+```bash
+npx intlayer dictionaries build
+```
+
+или в режиме наблюдения
+
+```bash
+npx intlayer dictionaries build --watch
+```
+
+Эта команда найдет ваши файлы деклараций контента по умолчанию как `./src/**/*.content.{ts|js|mjs|cjs|json|tsx|jsx}` и соберет словари в директорию `.intlayer`.
+
+### Отправка словарей
+
+```bash
+npx intlayer dictionary push
+```
+
+Если установлен [редактор intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/ru/intlayer_visual_editor.md), вы также можете отправить словари в редактор. Эта команда позволит сделать словари доступными для [редактора](https://intlayer.org/dashboard). Таким образом, вы можете делиться своими словарями с командой и редактировать контент без изменения кода вашего приложения.
+
+##### Аргументы:
+
+- `-d`, `--dictionaries`: ID словарей для отправки. Если не указано, будут отправлены все словари.
+  > Пример: `npx intlayer dictionary push -d my-dictionary-id my-other-dictionary-id`
+- `-r`, `--deleteLocaleDictionary`: Пропускает вопрос об удалении директории локали после отправки словаря и удаляет. По умолчанию, если словарь определен локально, он перезаписывает содержимое удаленного словаря.
+  > Пример: `npx intlayer dictionary push -r`
+- `-k`, `--keepLocaleDictionary`: Пропускает вопрос об удалении директории локали после отправки словаря и сохраняет. По умолчанию, если словарь определен локально, он перезаписывает содержимое удаленного словаря.
+  > Пример: `npx intlayer dictionary push -k`
+- `--env`: Указывает окружение (например, `development`, `production`).
+- `--env-file`: Предоставляет пользовательский файл окружения для загрузки переменных.
+- `--base-dir`: Указывает базовую директорию проекта.
+- `--verbose`: Включает подробное логирование для отладки.
+- `--git-diff`: Выполняет только словари с неотправленными изменениями в git-репозитории.
+- `--git-diff-base`: Указывает базовую ссылку для git diff.
+- `--git-diff-current`: Указывает текущую ссылку для git diff.
+- `--uncommitted`: Включает незакоммиченные изменения.
+- `--unpushed`: Включает неотправленные изменения.
+- `--untracked`: Включает неотслеживаемые файлы.
+
+### Получение удаленных словарей
+
+```bash
+npx intlayer dictionary pull
+```
+
+Если у вас установлен [Визуальный редактор Intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/ru/intlayer_visual_editor.md), вы также можете получить словари из редактора. Это позволяет перезаписать содержимое словарей в соответствии с потребностями вашего приложения.
+
+##### Аргументы:
+
+- `-d, --dictionaries`: ID словарей для получения. Если не указано, будут получены все словари.
+  > Пример: `npx intlayer dictionary pull -d my-dictionary-id my-other-dictionary-id`
+- `--newDictionariesPath`: Путь к директории, где будут храниться новые словари. Если не указано, новые словари будут храниться в директории `./intlayer-dictionaries` проекта. Если в содержимом словаря указано поле `filePath`, словарь будет храниться в указанной директории `filePath`, игнорируя этот аргумент.
+- `--env`: Указывает окружение (например, `development`, `production`).
+- `--env-file`: Предоставляет пользовательский файл окружения для загрузки переменных.
+- `--base-dir`: Указывает базовую директорию проекта.
+- `--verbose`: Включает подробное логирование для отладки.
+
+##### Пример:
+
+```bash
+npx intlayer dictionary pull --newDictionariesPath ./my-dictionaries-dir/
+```
+
+### Аудит словарей
+
+```bash
+npx intlayer audit
+```
+
+Эта команда анализирует файлы объявления контента для поиска потенциальных проблем, таких как отсутствующие переводы, структурные несоответствия или несовместимости типов. Если проблемы найдены, **intlayer audit** предлагает или применяет обновления для поддержания словарей согласованными и полными.
+
+##### Аргументы:
+
+- **`-f, --files [files...]`**  
+  Список конкретных файлов объявления контента для аудита. Если не указано, будут проверены все найденные файлы `*.content.{ts,js,mjs,cjs,tsx,jsx,json}`.
+
+- **`--exclude [excludedGlobs...]`**  
+  Шаблоны glob для исключения из аудита (например, `--exclude "src/test/**"`).
+
+- **`--source-locale [sourceLocale]`**  
+  Исходная локаль для перевода. Если не указано, будет использована локаль по умолчанию из конфигурации.
+
+- **`--output-locales [outputLocales...]`**  
+  Целевые локали для перевода. Если не указано, будут использованы все локали из конфигурации, кроме исходной локали.
+
+- **`--mode [mode]`**  
+  Режим перевода: 'complete', 'review' или 'missing-only'. По умолчанию 'missing-only'.
+
+- **`--git-diff`**  
+  Выполняет только словари с неотправленными изменениями в git-репозитории.
+
+- **`--git-diff-base`**  
+  Указывает базовую ссылку для git diff.
+
+- **`--git-diff-current`**  
+  Указывает текущую ссылку для git diff.
+
+- **`--uncommitted`**  
+  Включает незакоммиченные изменения.
+
+- **`--unpushed`**  
+  Включает неотправленные изменения.
+
+- **`--untracked`**  
+  Включает неотслеживаемые файлы.
+
+- **`--keys [keys...]`**  
+  Фильтрует словари на основе указанных ключей.
+
+- **`--excluded-keys [excludedKeys...]`**  
+  Исключает словари на основе указанных ключей.
+
+- **`--path-filter [pathFilters...]`**  
+  Фильтрует словари на основе шаблонов glob пути к файлу.
+
+- **`--model [model]`**  
+  Модель ИИ для использования при переводе (например, `gpt-3.5-turbo`).
+
+- **`--provider [provider]`**  
+  Провайдер ИИ для использования при переводе.
+
+- **`--temperature [temperature]`**  
+  Настройка температуры для модели ИИ.
+
+- **`--api-key [apiKey]`**  
+  Предоставляет собственный API-ключ для сервиса ИИ.
+
+- **`--custom-prompt [prompt]`**  
+  Предоставляет пользовательский промпт для инструкций по переводу.
+
+- **`--application-context [applicationContext]`**  
+  Предоставляет дополнительный контекст для перевода ИИ.
+
+- **`--env`**  
+  Указывает окружение (например, `development`, `production`).
+
+- **`--env-file [envFile]`**  
+  Предоставляет пользовательский файл окружения для загрузки переменных.
+
+- **`--base-dir`**  
+  Указывает базовую директорию проекта.
+
+- **`--verbose`**  
+  Включает подробное логирование для отладки.
+
+##### Пример:
+
+```bash
+npx intlayer fill --file src/home/*.content.ts --source-locale en --output-locales fr es --model gpt-3.5-turbo
+```
+
+Эта команда переводит содержимое всех файлов объявления контента в директории `src/home/` с английского на французский и испанский языки, используя модель GPT-3.5 Turbo.
+
+### Управление конфигурацией
+
+#### Получение конфигурации
+
+Команда `get configuration` получает текущую конфигурацию Intlayer, особенно настройки локали. Это полезно для проверки конфигурации.
+
+```bash
+npx intlayer config get
+```
+
+##### Аргументы:
+
+- **`--env`**: Указывает окружение (например, `development`, `production`).
+- **`--env-file`**: Предоставляет пользовательский файл окружения для загрузки переменных.
+- **`--base-dir`**: Указывает базовую директорию проекта.
+- **`--verbose`**: Включает подробное логирование для отладки.
+
+#### Отправка конфигурации
+
+Команда `push configuration` загружает конфигурацию в CMS и редактор Intlayer. Этот шаг необходим для использования удаленных словарей в Визуальном редакторе Intlayer.
+
+```bash
+npx intlayer config push
+```
+
+##### Аргументы:
+
+- **`--env`**: Указывает окружение (например, `development`, `production`).
+- **`--env-file`**: Предоставляет пользовательский файл окружения для загрузки переменных.
+- **`--base-dir`**: Указывает базовую директорию проекта.
+- **`--verbose`**: Включает подробное логирование для отладки.
+
+При отправке конфигурации ваш проект полностью интегрируется с CMS Intlayer, обеспечивая безупречное управление словарями между командами.
+
+## Использование команд intlayer в `package.json`
+
+```json fileName="package.json"
+"scripts": {
+  "intlayer:build": "npx intlayer dictionaries build",
+  "intlayer:watch": "npx intlayer dictionaries build --watch",
+  "intlayer:push": "npx intlayer dictionary push",
+  "intlayer:pull": "npx intlayer dictionary pull",
+  "intlayer:audit": "npx intlayer audit"
+}
+```
+
+## Отладка команды intlayer
+
+### 1. **Убедитесь, что используете последнюю версию**
+
+Выполните:
+
+```bash
+npx intlayer --version                  # текущая локальная версия intlayer
+npx intlayer@latest --version          # последняя версия intlayer
+```
+
+### 2. **Проверьте, зарегистрирована ли команда**
+
+Вы можете проверить с помощью:
+
+```bash
+npx intlayer --help      # Показывает список доступных команд и информацию об использовании
+```
+
+### 3. **Перезапустите терминал**
+
+Иногда требуется перезапуск терминала для распознавания новых команд.
+
+### 4. **Очистите кэш npx (если застряли на старой версии)**
+
+```bash
+npx clear-npx-cache
+```

package/ru/intlayer_visual_editor.md

@@ -0,0 +1,210 @@
+# Intlayer Visual Editor Документация
+
+<iframe title="Visual Editor + CMS for Your Web App: Intlayer Explained" class="m-auto aspect-[16/9] w-full overflow-hidden rounded-lg border-0" allow="autoplay; gyroscope;" loading="lazy" width="1080" height="auto" src="https://www.youtube.com/embed/UDDTnirwi_4?autoplay=0&amp;origin=http://intlayer.org&amp;controls=0&amp;rel=1"/>
+
+Intlayer Visual Editor , это инструмент, который оборачивает ваш веб-сайт для взаимодействия с вашими файлами декларации контента с использованием визуального редактора.
+
+![Интерфейс Intlayer Visual Editor](https://github.com/aymericzip/intlayer/blob/main/docs/assets/visual_editor.gif)
+
+Пакет `intlayer-editor` основан на Intlayer и доступен для JavaScript приложений, таких как React (Create React App), Vite + React и Next.js.
+
+## Визуальный редактор vs CMS
+
+Intlayer Visual Editor , это инструмент, который позволяет управлять вашим контентом в визуальном редакторе для локальных словарей. После внесения изменений контент будет заменен в кодовой базе. Это означает, что приложение будет пересобрано, и страница будет перезагружена для отображения нового контента.
+
+В отличие от этого, [Intlayer CMS](https://github.com/aymericzip/intlayer/blob/main/docs/ru/intlayer_CMS.md) , это инструмент, который позволяет управлять вашим контентом в визуальном редакторе для удаленных словарей. После внесения изменений контент **не** будет влиять на вашу кодовую базу. И веб-сайт автоматически отобразит измененный контент.
+
+## Интеграция Intlayer в ваше приложение
+
+Для получения более подробной информации о том, как интегрировать Intlayer, см. соответствующий раздел ниже:
+
+### Интеграция с Next.js
+
+Для интеграции с Next.js обратитесь к [руководству по настройке](https://github.com/aymericzip/intlayer/blob/main/docs/ru/intlayer_with_nextjs_15.md).
+
+### Интеграция с Create React App
+
+Для интеграции с Create React App обратитесь к [руководству по настройке](https://github.com/aymericzip/intlayer/blob/main/docs/ru/intlayer_with_create_react_app.md).
+
+### Интеграция с Vite + React
+
+Для интеграции с Vite + React обратитесь к [руководству по настройке](https://github.com/aymericzip/intlayer/blob/main/docs/ru/intlayer_with_vite+react.md).
+
+## Как работает Intlayer Editor
+
+Визуальный редактор в приложении включает в себя две вещи:
+
+- Фронтенд-приложение, которое отображает ваш веб-сайт в iframe. Если ваш веб-сайт использует Intlayer, визуальный редактор автоматически обнаружит ваш контент и позволит вам взаимодействовать с ним. После внесения изменений вы сможете скачать изменения.
+
+- После нажатия кнопки загрузки визуальный редактор отправит запрос на сервер для замены ваших файлов декларации контента новым контентом (где бы эти файлы ни были объявлены в вашем проекте).
+
+> Обратите внимание, что на данный момент Intlayer Editor записывает ваши файлы декларации контента в формате JSON.
+
+## Установка
+
+После настройки Intlayer в вашем проекте просто установите `intlayer-editor` как зависимость для разработки:
+
+```bash packageManager="npm"
+npm install intlayer-editor --save-dev
+```
+
+```bash packageManager="yarn"
+yarn add intlayer-editor --save-dev
+```
+
+```bash packageManager="pnpm"
+pnpm add intlayer-editor --save-dev
+```
+
+## Конфигурация
+
+В вашем файле конфигурации Intlayer вы можете настроить параметры редактора:
+
+```typescript fileName="intlayer.config.ts" codeFormat="typescript"
+import type { IntlayerConfig } from "intlayer";
+
+const config: IntlayerConfig = {
+  // ... другие настройки конфигурации
+  editor: {
+    /**
+     * Обязательно
+     * URL приложения.
+     * Это URL, на который нацелен визуальный редактор.
+     * Пример: 'http://localhost:3000'
+     */
+    applicationURL: process.env.INTLAYER_APPLICATION_URL,
+    /**
+     * Необязательно
+     * По умолчанию `true`. Если `false`, редактор неактивен и недоступен.
+     * Может использоваться для отключения редактора в определенных средах, например, в продакшене.
+     */
+    enabled: process.env.INTLAYER_ENABLED,
+    /**
+     * Необязательно
+     * По умолчанию `8000`.
+     * Порт сервера редактора.
+     */
+    port: process.env.INTLAYER_PORT,
+    /**
+     * Необязательно
+     * По умолчанию "http://localhost:8000"
+     * URL сервера редактора.
+     */
+    editorURL: process.env.INTLAYER_EDITOR_URL,
+  },
+};
+
+export default config;
+```
+
+```javascript fileName="intlayer.config.mjs" codeFormat="esm"
+/** @type {import('intlayer').IntlayerConfig} */
+const config = {
+  // ... другие настройки конфигурации
+  editor: {
+    /**
+     * Обязательно
+     * URL приложения.
+     * Это URL, на который нацелен визуальный редактор.
+     * Пример: 'http://localhost:3000'
+     */
+    applicationURL: process.env.INTLAYER_APPLICATION_URL,
+    /**
+     * Необязательно
+     * По умолчанию `true`. Если `false`, редактор неактивен и недоступен.
+     * Может использоваться для отключения редактора в определенных средах, например, в продакшене.
+     */
+    enabled: process.env.INTLAYER_ENABLED,
+    /**
+     * Необязательно
+     * По умолчанию `8000`.
+     * Порт, используемый сервером визуального редактора.
+     */
+    port: process.env.INTLAYER_PORT,
+    /**
+     * Необязательно
+     * По умолчанию "http://localhost:8000"
+     * URL сервера редактора для доступа из приложения. Используется для ограничения источников, которые могут взаимодействовать с приложением по соображениям безопасности. Если установлено значение `'*'`, редактор доступен из любого источника. Должен быть установлен, если порт изменен или если редактор размещен на другом домене.
+     */
+    editorURL: process.env.INTLAYER_EDITOR_URL,
+  },
+};
+
+export default config;
+```
+
+```javascript fileName="intlayer.config.cjs" codeFormat="commonjs"
+/** @type {import('intlayer').IntlayerConfig} */
+const config = {
+  // ... другие настройки конфигурации
+  editor: {
+    /**
+     * Обязательно
+     * URL приложения.
+     * Это URL, на который нацелен визуальный редактор.
+     */
+    applicationURL: process.env.INTLAYER_APPLICATION_URL,
+    /**
+     * Необязательно
+     * По умолчанию `8000`.
+     * Порт сервера редактора.
+     */
+    port: process.env.INTLAYER_PORT,
+    /**
+     * Необязательно
+     * По умолчанию "http://localhost:8000"
+     * URL сервера редактора.
+     */
+    editorURL: process.env.INTLAYER_EDITOR_URL,
+    /**
+     * Необязательно
+     * По умолчанию `true`. Если `false`, редактор неактивен и недоступен.
+     * Может использоваться для отключения редактора в определенных средах, например, в продакшене.
+     */
+    enabled: process.env.INTLAYER_ENABLED,
+  },
+};
+
+module.exports = config;
+```
+
+> Чтобы увидеть все доступные параметры, обратитесь к [документации по конфигурации](https://github.com/aymericzip/intlayer/blob/main/docs/ru/configuration.md).
+
+## Использование редактора
+
+1. После установки редактора вы можете запустить его с помощью следующей команды:
+
+   ```bash packageManager="npm"
+   npx intlayer-editor start
+   ```
+
+   ```bash packageManager="yarn"
+   yarn intlayer-editor start
+   ```
+
+   ```bash packageManager="pnpm"
+   pnpm intlayer-editor start
+   ```
+
+   > **Обратите внимание, что ваше приложение должно работать параллельно.** URL приложения должен совпадать с тем, который вы указали в конфигурации редактора (`applicationURL`).
+
+2. Затем откройте предоставленный URL. По умолчанию `http://localhost:8000`.
+
+   Вы можете просмотреть каждое поле, индексированное Intlayer, наведя курсор на ваш контент.
+
+   ![Наведение на контент](https://github.com/aymericzip/intlayer/blob/main/docs/assets/intlayer_editor_hover_content.png)
+
+3. Если ваш контент выделен, вы можете долго нажимать на него, чтобы отобразить панель редактирования.
+
+## Отладка
+
+Если вы столкнулись с какими-либо проблемами с визуальным редактором, проверьте следующее:
+
+- Визуальный редактор и приложение работают.
+
+- Конфигурация [`editor`](https://intlayer.org/ru/doc/concept/configuration#editor-configuration) правильно настроена в вашем файле конфигурации Intlayer.
+
+  - Обязательные поля:
+    - URL приложения должен совпадать с тем, который вы указали в конфигурации редактора (`applicationURL`).
+
+- Визуальный редактор использует iframe для отображения вашего веб-сайта. Убедитесь, что политика безопасности контента (CSP) вашего веб-сайта позволяет URL CMS как `frame-ancestors` ('http://localhost:8000' по умолчанию). Проверьте консоль редактора на наличие ошибок.

package/ru/intlayer_with_angular.md

@@ -0,0 +1,3 @@
+this doc will be automatically generated translated from the english doc
+
+see /docs/en/intlayer_with_vite+preact.md