@intlayer/docs 5.5.8

package/ru/roadmap.md

@@ -0,0 +1,206 @@
+# Intlayer: Обзор функций и дорожная карта
+
+Intlayer , это решение для управления контентом и интернационализации, разработанное для упрощения декларации, управления и обновления контента в ваших приложениях. Оно предлагает мощные функции, такие как централизованная или распределенная декларация контента, обширные возможности интернационализации, поддержка Markdown, условный рендеринг, интеграция с TypeScript/JavaScript/JSON и многое другое. Ниже представлен подробный обзор текущих возможностей Intlayer, а также будущих функций дорожной карты.
+
+---
+
+## Текущие функции
+
+### 1. Декларация контента
+
+#### Централизованная или распределенная
+
+- **Централизованная**: Декларируйте весь ваш контент в одном большом файле в основе вашего приложения, аналогично i18next, чтобы управлять всем в одном месте.
+- **Распределенная**: Альтернативно, разделите ваш контент на отдельные файлы на уровне компонентов или функций для лучшей поддерживаемости. Это позволяет держать контент рядом с соответствующим кодом (компоненты, тесты, Storybook и т.д.). Удаление компонента гарантирует, что любой связанный контент также будет удален, предотвращая накопление ненужных данных в вашем коде.
+
+> Ресурсы:
+
+> - [Декларация контента](https://github.com/aymericzip/intlayer/blob/main/docs/ru/dictionary/get_started.md)
+
+### 2. Интернационализация
+
+- Поддержка **230 языков и локалей** (включая региональные варианты, такие как французский (Франция), английский (Канада), английский (Великобритания), португальский (Португалия) и т.д.).
+- Легкое управление переводами для всех этих локалей из одного места.
+
+> Ресурсы:
+
+> - [Интернационализация](https://github.com/aymericzip/intlayer/blob/main/docs/ru/dictionary/translation.md)
+
+### 3. Поддержка Markdown
+
+- Декларируйте контент с использованием **Markdown**, что позволяет автоматически форматировать текст с абзацами, заголовками, ссылками и многим другим.
+- Идеально подходит для блогов, статей, страниц документации или любых сценариев, где требуется форматирование текста.
+
+> Ресурсы:
+
+> - [Markdown](https://github.com/aymericzip/intlayer/blob/main/docs/ru/dictionary/markdown.md)
+
+### 4. Условный рендеринг
+
+- Определяйте контент, который адаптируется на основе определенных условий, таких как язык пользователя, статус входа пользователя или любая другая переменная, связанная с контекстом.
+- Помогает создавать персонализированные впечатления без дублирования контента в нескольких файлах.
+
+> Ресурсы:
+
+> - [Условный рендеринг](https://github.com/aymericzip/intlayer/blob/main/docs/ru/dictionary/condition.md)
+
+### 5. Форматы декларации контента
+
+Intlayer поддерживает **TypeScript** (также JavaScript) и **JSON** для декларации контента.
+
+- **TypeScript**:
+
+  - Обеспечивает правильность структуры вашего контента и отсутствие пропущенных переводов.
+  - Предлагает строгие или более гибкие режимы проверки.
+  - Позволяет динамически получать данные из переменных, функций или внешних API.
+
+- **JSON**:
+
+  - Упрощает интеграцию с внешними инструментами (например, визуальными редакторами) благодаря стандартизированному формату.
+
+  > Ресурсы:
+  >
+  > - [Форматы декларации контента](https://github.com/aymericzip/intlayer/blob/main/docs/ru/dictionary/content_extention_customization.md)
+
+---
+
+## Интеграция с фреймворками и средами
+
+### 1. Next.js
+
+#### a. Серверные и клиентские компоненты
+
+- Обеспечивает **унифицированный подход к управлению контентом** как для серверных, так и для клиентских компонентов.
+- Предлагает встроенный контекст для серверных компонентов, упрощая реализацию по сравнению с другими решениями.
+
+#### b. Метаданные, карты сайта и robots.txt
+
+- Динамически извлекайте и внедряйте контент для генерации метаданных, карт сайта или файлов `robots.txt`.
+
+#### c. Middleware
+
+- Добавьте middleware для **перенаправления пользователей** на контент на основе их предпочтительного языка.
+
+#### d. Совместимость с Turbopack и Webpack
+
+- Полностью совместим с новым Turbopack от Next.js, а также с традиционным Webpack.
+
+> Ресурсы:
+
+> - [Next.js](https://github.com/aymericzip/intlayer/blob/main/docs/ru/intlayer_with_nextjs_15.md)
+
+### 2. Vite
+
+- Аналогично Next.js, вы можете интегрировать Intlayer с Vite и использовать **middleware** для перенаправления пользователей на контент на основе их предпочтительного языка.
+
+> Ресурсы:
+
+> - [Vite](https://github.com/aymericzip/intlayer/blob/main/docs/ru/intlayer_with_vite+react.md)
+
+### 3. Express
+
+- Управляйте контентом и интернационализируйте бэкенд-сервисы, построенные на Express.
+- Персонализируйте электронные письма, сообщения об ошибках, push-уведомления и многое другое с локализованным текстом.
+
+> Ресурсы:
+
+> - [Express](https://github.com/aymericzip/intlayer/blob/main/docs/ru/intlayer_with_express.md)
+
+---
+
+## Визуальные редакторы и CMS
+
+### 1. Локальный визуальный редактор
+
+- **Бесплатный локальный визуальный редактор**, который позволяет редактировать контент вашего приложения, непосредственно выбирая элементы на странице.
+- Интегрирует функции ИИ для:
+  - Генерации или исправления переводов
+  - Проверки синтаксиса и орфографии
+  - Предложения улучшений
+- Может быть размещен локально или развернут на удаленном сервере.
+
+> Ресурсы:
+
+> - [Визуальный редактор](https://github.com/aymericzip/intlayer/blob/main/docs/ru/intlayer_visual_editor.md)
+
+### 2. Intlayer CMS (удаленный)
+
+- **Хостинг CMS**, который позволяет управлять контентом приложения онлайн, не касаясь вашего кода.
+- Предоставляет функции ИИ для декларации контента, управления переводами и исправления синтаксиса или орфографических ошибок.
+- Взаимодействуйте с вашим контентом через интерфейс вашего живого приложения.
+
+> Ресурсы:
+
+> - [CMS](https://github.com/aymericzip/intlayer/blob/main/docs/ru/intlayer_CMS.md)
+
+---
+
+## Intlayer CLI
+
+- **Аудит и генерация переводов**: Выполняйте аудит ваших файлов контента для генерации отсутствующих переводов или выявления неиспользуемых.
+- **Удаленное взаимодействие**: Публикуйте ваш локальный контент в удаленный CMS или извлекайте удаленный контент для интеграции в ваше локальное приложение.
+- Полезно для **CI/CD конвейеров**, обеспечивая синхронизацию контента с вашим кодом.
+
+> Ресурсы:
+
+> - [CLI](https://github.com/aymericzip/intlayer/blob/main/docs/ru/intlayer_cli.md)
+
+---
+
+## Среды
+
+- Используйте **переменные окружения** для настройки Intlayer в зависимости от среды: производственной, тестовой или локальной.
+- Определяйте, какой визуальный редактор или проект удаленного CMS использовать в зависимости от вашей среды.
+
+---
+
+## Горячие обновления контента
+
+- При использовании удаленных словарей и Intlayer CMS вы можете **обновлять контент вашего приложения на лету**, без необходимости повторного развертывания.
+
+> Ресурсы:
+
+> - [CMS](https://github.com/aymericzip/intlayer/blob/main/docs/ru/intlayer_CMS.md)
+
+---
+
+## Дорожная карта: Будущие функции
+
+### 1. A/B тестирование и персонализация
+
+- **Многовариантное тестирование**: Тестируйте разные версии одного и того же контента, чтобы определить, какая из них работает лучше (например, с более высоким коэффициентом кликов).
+- **Персонализация на основе данных**: Отображайте разный контент в зависимости от демографических данных пользователя (пол, возраст, местоположение и т.д.) или других поведенческих факторов.
+- **Автоматизированная итерация**: Позвольте ИИ автоматически тестировать несколько версий и либо выбирать лучшую, либо рекомендовать варианты для утверждения администратором.
+
+### 2. Версионирование
+
+- Восстанавливайте предыдущие версии вашего контента с помощью **версий контента**.
+- Отслеживайте изменения со временем и возвращайтесь к более ранним состояниям при необходимости.
+
+### 3. Автоматический перевод
+
+- Для пользователей удаленного CMS: **генерация перевода в один клик** для любого поддерживаемого языка.
+- Система будет генерировать переводы в фоновом режиме, а затем предлагать вам их для проверки или редактирования.
+
+### 4. Улучшения SEO
+
+- Инструменты для **анализа ключевых слов**, намерений пользователей и новых трендов.
+- Предлагайте улучшенный контент для повышения рейтинга и отслеживайте долгосрочную производительность.
+
+### 5. Совместимость с большим количеством фреймворков
+
+- Ведется работа над поддержкой **Vue, Solid, Svelte, Angular** и других.
+- Цель , сделать Intlayer совместимым с **любым приложением на JavaScript**.
+
+### 6. Расширения для IDE
+
+- Расширения для основных IDE, предоставляющие **графический интерфейс** для управления локальными и удаленными переводами.
+- Возможности могут включать автоматическую генерацию файлов декларации контента для компонентов, прямую интеграцию с Intlayer CMS и проверку в реальном времени.
+
+---
+
+## Заключение
+
+Intlayer стремится стать универсальным решением для управления контентом и интернационализации. Оно фокусируется на гибкости (централизованные или распределенные файлы), широкой поддержке языков, легкой интеграции с современными фреймворками и сборщиками, а также мощных функциях, основанных на ИИ. С появлением новых возможностей, таких как A/B тестирование, версионирование и автоматические переводы, Intlayer продолжит упрощать рабочие процессы с контентом и улучшать пользовательский опыт на различных платформах.
+
+Следите за новыми релизами и не стесняйтесь изучать существующие функции, чтобы увидеть, как Intlayer может помочь централизовать и оптимизировать ваши процессы управления контентом уже сегодня!

package/ru/terms_of_service.md

@@ -0,0 +1,33 @@
+# Условия использования Intlayer
+
+## 1. Принятие условий
+
+Используя Intlayer, вы соглашаетесь соблюдать эти условия использования. Если вы не принимаете эти условия, пожалуйста, не используйте этот инструмент.
+
+## 2. Лицензия
+
+Intlayer распространяется под лицензией **Apache 2.0**, которая позволяет использовать, модифицировать и распространять код как для проектов с открытым исходным кодом, так и для коммерческих проектов. Пользователи могут модифицировать исходный код и отправлять свои вклады через pull-запросы в соответствии с руководством, изложенным в нашем [руководстве по вкладам](https://github.com/aymericzip/intlayer/blob/main/CONTRIBUTING.md). Кража кода для коммерческого использования строго запрещена.
+
+## 3. Коммерческое использование
+
+Вам разрешено использовать Intlayer для коммерческих проектов. Однако повторное использование кода для создания инструментов-конкурентов на основе Intlayer без значительных преобразований или добавления существенной ценности запрещено.
+
+## 4. Ответственность
+
+Разработчики Intlayer стремятся исправлять ошибки и проблемы с безопасностью, как только они обнаруживаются. Однако они отказываются от ответственности за ущерб, вызванный такими проблемами на пользовательской инфраструктуре. Мы призываем пользователей сообщать о проблемах через нашу [систему отслеживания проблем](https://github.com/aymericzip/intlayer/issues).
+
+## 5. Конфиденциальность
+
+Intlayer не собирает и не хранит никакие персональные данные пользователей.
+
+## 6. Вклады
+
+Пользователи поощряются к внесению вклада в Intlayer, следуя руководству, предоставленному в нашем руководстве по вкладам. Любой отправленный код должен соответствовать установленным стандартам качества и будет рассмотрен разработчиками перед интеграцией.
+
+## 7. Атрибуция
+
+Любой инструмент, разработанный для расширения или использования кода Intlayer, должен явно указывать Intlayer как основу кода. Эта атрибуция должна быть видна в исходном коде, а также в любой пользовательской или рекламной документации.
+
+## 8. Изменение условий
+
+Эти условия использования могут быть изменены в любое время. Пользователи будут уведомлены о любых значительных изменениях в условиях использования и должны принять изменения, чтобы продолжить использование Intlayer.

package/ru/vs_code_extension.md

@@ -0,0 +1,139 @@
+# Официальное расширение для VS Code
+
+## Обзор
+
+**Intlayer** , это официальное расширение Visual Studio Code для **Intlayer**, разработанное для улучшения опыта разработчиков при работе с локализованным контентом в проектах на **React, Next.js и JavaScript**.
+
+С помощью этого расширения разработчики могут **быстро перемещаться** к своим словарям контента, управлять файлами локализации и оптимизировать свой рабочий процесс с помощью мощных автоматизированных команд.
+
+![Intlayer VS Code Extension](https://github.com/aymericzip/intlayer/blob/main/docs/assets/vs_code_extension_demo.gif)
+
+Ссылка на расширение: [https://marketplace.visualstudio.com/items?itemName=Intlayer.intlayer-vs-code-extension](https://marketplace.visualstudio.com/items?itemName=Intlayer.intlayer-vs-code-extension)
+
+## Возможности
+
+### Мгновенная навигация
+
+**Поддержка перехода к определению** – Используйте `Cmd+Click` (Mac) или `Ctrl+Click` (Windows/Linux) на ключе `useIntlayer`, чтобы мгновенно открыть соответствующий файл контента.  
+**Бесшовная интеграция** – Работает без проблем с проектами **react-intlayer** и **next-intlayer**.  
+**Поддержка нескольких языков** – Поддерживает локализованный контент на разных языках.  
+**Интеграция с VS Code** – Плавно интегрируется с навигацией и палитрой команд VS Code.
+
+### Команды управления словарями
+
+Управляйте своими словарями контента прямо из VS Code:
+
+- **Создание словарей** (`extension.buildDictionaries`) – Генерация файлов контента на основе структуры вашего проекта.
+- **Отправка словарей** (`extension.pushDictionaries`) – Загрузка последнего содержимого словарей в ваш репозиторий.
+- **Получение словарей** (`extension.pullDictionaries`) – Синхронизация последнего содержимого словарей из вашего репозитория в локальную среду.
+
+### Генератор деклараций контента
+
+Легко создавайте структурированные файлы словарей в различных форматах:
+
+- **TypeScript (`.ts`)** – `extension.createDictionaryFile.ts`
+- **ES Module (`.esm`)** – `extension.createDictionaryFile.esm`
+- **CommonJS (`.cjs`)** – `extension.createDictionaryFile.cjs`
+- **JSON (`.json`)** – `extension.createDictionaryFile.json`
+
+## Установка
+
+Вы можете установить **Intlayer** напрямую из VS Code Marketplace:
+
+1. Откройте **VS Code**.
+2. Перейдите в **Marketplace расширений**.
+3. Найдите **"Intlayer"**.
+4. Нажмите **Установить**.
+
+Или установите через командную строку:
+
+```sh
+code --install-extension intlayer
+```
+
+## Использование
+
+### Быстрая навигация
+
+1. Откройте проект, использующий **react-intlayer**.
+2. Найдите вызов `useIntlayer()`, например:
+
+   ```tsx
+   const content = useIntlayer("app");
+   ```
+
+3. **Command-click** (`⌘+Click` на macOS) или **Ctrl+Click** (на Windows/Linux) на ключе (например, `"app"`).
+4. VS Code автоматически откроет соответствующий файл словаря, например, `src/app.content.ts`.
+
+### Управление словарями контента
+
+#### Создание словарей
+
+Создайте все файлы контента словарей с помощью:
+
+```sh
+Cmd + Shift + P (macOS) / Ctrl + Shift + P (Windows/Linux)
+```
+
+Найдите **Build Dictionaries** и выполните команду.
+
+#### Отправка словарей
+
+Загрузите последнее содержимое словарей:
+
+1. Откройте **Палитру команд**.
+2. Найдите **Push Dictionaries**.
+3. Выберите словари для отправки и подтвердите.
+
+#### Получение словарей
+
+Синхронизируйте последнее содержимое словарей:
+
+1. Откройте **Палитру команд**.
+2. Найдите **Pull Dictionaries**.
+3. Выберите словари для получения.
+
+### Настройка путей к файлам словарей
+
+По умолчанию расширение следует стандартной структуре проекта **Intlayer**. Однако вы можете настроить пользовательские пути:
+
+1. Откройте **Настройки (`Cmd + ,` на macOS / `Ctrl + ,` на Windows/Linux)`**.
+2. Найдите `Intlayer`.
+3. Настройте параметр пути к файлам контента.
+
+## Разработка и вклад
+
+Хотите внести вклад? Мы приветствуем участие сообщества!
+
+URL репозитория: https://github.com/aymericzip/intlayer-vs-code-extension
+
+### Начало работы
+
+Клонируйте репозиторий и установите зависимости:
+
+```sh
+git clone https://github.com/aymericzip/intlayer-vs-code-extension.git
+cd intlayer-vs-code-extension
+npm install
+```
+
+> Используйте менеджер пакетов `npm` для совместимости с пакетом `vsce` для сборки и публикации расширения.
+
+### Запуск в режиме разработки
+
+1. Откройте проект в **VS Code**.
+2. Нажмите `F5`, чтобы запустить новое окно **Extension Development Host**.
+
+### Отправка Pull Request
+
+Если вы улучшили расширение, отправьте PR на [GitHub](https://github.com/aymericzip/intlayer-vs-code-extension).
+
+## Обратная связь и проблемы
+
+Нашли ошибку или хотите предложить новую функцию? Откройте задачу в нашем **репозитории GitHub**:
+
+[GitHub Issues](https://github.com/aymericzip/intlayer-vs-code-extension/issues)
+
+## Лицензия
+
+Intlayer распространяется под лицензией **MIT License**.

package/zh/CI_CD.md

@@ -0,0 +1,149 @@
+# 在 CI/CD 管道中自动生成翻译
+
+Intlayer 允许为您的内容声明文件自动生成翻译。根据您的工作流程，有多种方法可以实现这一点。
+
+## 使用 CMS
+
+通过 Intlayer，您可以采用一种工作流程，其中仅在本地声明一个语言环境，而所有翻译都通过 CMS 远程管理。这使得内容和翻译可以完全与代码库分离，为内容编辑者提供了更大的灵活性，并支持热内容重新加载（无需重新构建应用程序即可应用更改）。
+
+### 示例配置
+
+```ts fileName="intlayer.config.ts"
+import { Locales, type IntlayerConfig } from "intlayer";
+
+const config: IntlayerConfig = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.SPANISH, Locales.FRENCH],
+    requiredLocales: [Locales.ENGLISH], // 可选语言环境将由远程管理
+    defaultLocale: Locales.ENGLISH,
+  },
+  editor: {
+    dictionaryPriorityStrategy: "distant_first", // 远程内容优先
+
+    applicationURL: process.env.APPLICATION_URL, // CMS 使用的应用程序 URL
+
+    clientId: process.env.INTLAYER_CLIENT_ID, // CMS 凭据
+    clientSecret: process.env.INTLAYER_CLIENT_SECRET,
+  },
+  ai: {
+    applicationContext: "This is a test application", // 帮助确保翻译生成的一致性
+  },
+};
+
+export default config;
+```
+
+要了解有关 CMS 的更多信息，请参阅[官方文档](https://github.com/aymericzip/intlayer/blob/main/docs/zh/intlayer_CMS.md)。
+
+## 使用 Husky
+
+您可以使用 [Husky](https://typicode.github.io/husky/) 将翻译生成集成到本地 Git 工作流程中。
+
+### 示例配置
+
+```ts fileName="intlayer.config.ts"
+import { Locales, type IntlayerConfig } from "intlayer";
+
+const config: IntlayerConfig = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.SPANISH, Locales.FRENCH],
+    requiredLocales: [Locales.ENGLISH], // 可选语言环境由远程处理
+    defaultLocale: Locales.ENGLISH,
+  },
+  editor: {
+    clientId: process.env.INTLAYER_CLIENT_ID,
+    clientSecret: process.env.INTLAYER_CLIENT_SECRET,
+  },
+  ai: {
+    provider: "openai",
+    apiKey: process.env.OPENAI_API_KEY, // 使用您自己的 API 密钥
+
+    applicationContext: "This is a test application", // 帮助确保翻译生成的一致性
+  },
+};
+
+export default config;
+```
+
+```bash fileName=".husky/pre-push"
+npx intlayer build                          # 确保字典是最新的
+npx intlayer fill --unpushed --mode fill    # 仅填充缺失内容，不更新现有内容
+```
+
+> 有关 Intlayer CLI 命令及其用法的更多信息，请参阅 [CLI 文档](https://github.com/aymericzip/intlayer/blob/main/docs/zh/intlayer_cli.md)。
+
+> 如果您的仓库中有多个应用程序使用单独的 Intlayer 实例，您可以使用 `--base-dir` 参数，如下所示：
+
+```bash fileName=".husky/pre-push"
+# 应用程序 1
+npx intlayer build --base-dir ./app1
+npx intlayer fill --base-dir ./app1 --unpushed --mode fill
+
+# 应用程序 2
+npx intlayer build --base-dir ./app2
+npx intlayer fill --base-dir ./app2 --unpushed --mode fill
+```
+
+## 使用 GitHub Actions
+
+Intlayer 提供了一个 CLI 命令，用于自动填充和审查字典内容。这可以通过 GitHub Actions 集成到您的 CI/CD 工作流程中。
+
+```yaml fileName=".github/workflows/intlayer-translate.yml"
+name: Intlayer Auto-Fill
+on:
+  push:
+    branches: [ main ]
+    paths:
+      - 'src/**'
+  pull_request:
+    branches: [ main ]
+    paths:
+      - 'src/**'
+  workflow_dispatch: {}
+
+concurrency:
+  group: 'autofill-${{ github.ref }}'
+  cancel-in-progress: true
+
+jobs:
+  autofill:
+    runs-on: ubuntu-latest
+    env:
+      INTLAYER_CLIENT_ID: ${{ secrets.INTLAYER_CLIENT_ID }}
+      INTLAYER_CLIENT_SECRET: ${{ secrets.INTLAYER_CLIENT_SECRET }}
+      OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+
+    steps:
+      - name: ⬇️ 检出代码库
+        uses: actions/checkout@v3
+        with:
+          persist-credentials: true
+
+      - name: 🟢 设置 Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+
+      - name: 📦 安装依赖
+        run: npm ci
+
+      - name: ⚙️ 构建 Intlayer 项目
+        run: npx intlayer build
+
+      - name: 🤖 自动填充缺失翻译
+        run: npx intlayer fill --git-diff --mode fill
+
+      - name: 📤 创建或更新翻译 PR
+        uses: peter-evans/create-pull-request@v4
+        with:
+          commit-message: chore: auto-fill missing translations [skip ci]
+          branch: auto-translations
+          title: chore: update missing translations
+          labels: translation, automated
+```
+
+> 与 Husky 相同，在 monorepo 的情况下，您可以使用 `--base-dir` 参数依次处理每个应用程序。
+
+> 默认情况下，`--git-diff` 参数会过滤从基线（默认 `origin/main`）到当前分支（默认：`HEAD`）的更改中包含的字典。
+
+> 有关 Intlayer CLI 命令及其用法的更多信息，请参阅 [CLI 文档](https://github.com/aymericzip/intlayer/blob/main/docs/zh/intlayer_cli.md)。