@intlayer/docs 6.0.2-canary.0 → 6.1.0

package/docs/ru/packages/intlayer-editor/index.md

@@ -1,139 +0,0 @@
----
-createdAt: 2025-02-07
-updatedAt: 2025-06-29
-title: intlayer-editor - Пакет визуального редактора переводов
-description: Пакет визуального редактора для Intlayer, предоставляющий интуитивно понятный интерфейс для управления переводами и совместного редактирования контента с помощью ИИ.
-keywords:
-  - intlayer
-  - редактор
-  - визуальный
-  - перевод
-  - совместный
-  - ИИ
-  - NPM
-  - интерфейс
-slugs:
-  - doc
-  - package
-  - intlayer-editor
----
-
-# intlayer-editor: NPM пакет для использования визуального редактора Intlayer
-
-**Intlayer** - это набор пакетов, разработанных специально для JavaScript-разработчиков. Он совместим с такими фреймворками, как React, React и Express.js.
-
-Пакет **`intlayer-editor`** - это NPM-пакет, который интегрирует визуальный редактор Intlayer в ваш проект на React.
-
-## Как работает редактор Intlayer
-
-Редактор Intlayer позволяет взаимодействовать с удалённым словарём Intlayer. Его можно установить на стороне клиента, превратив ваше приложение в редактор, похожий на CMS, для управления содержимым сайта на всех настроенных языках.
-
-![Интерфейс редактора Intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/assets/intlayer_editor_ui.png)
-
-## Установка
-
-Установите необходимый пакет, используя предпочитаемый менеджер пакетов:
-
-```bash packageManager="npm"
-npm install intlayer-editor
-```
-
-```bash packageManager="pnpm"
-pnpm add intlayer-editor
-```
-
-```bash packageManager="yarn"
-yarn add intlayer-editor
-```
-
-### Конфигурация
-
-В вашем конфигурационном файле Intlayer вы можете настроить параметры редактора:
-
-```typescript
-const config: IntlayerConfig = {
-  // ... другие настройки конфигурации
-  editor: {
-    enabled: process.env.INTLAYER_ENABLED === "true", // Если false, редактор неактивен и к нему нельзя получить доступ.
-    // Для активации редактора требуются client ID и client secret.
-    // Они позволяют идентифицировать пользователя, который редактирует содержимое.
-    // Их можно получить, создав нового клиента в Intlayer Dashboard - Projects (https://intlayer.org/dashboard/projects).
-    clientId: process.env.INTLAYER_CLIENT_ID,
-    clientSecret: process.env.INTLAYER_CLIENT_SECRET,
-  },
-};
-```
-
-> Если у вас нет client ID и client secret, вы можете получить их, создав нового клиента в [Intlayer Dashboard - Projects](https://intlayer.org/dashboard/projects).
-
-> Чтобы увидеть все доступные параметры, обратитесь к [документации по конфигурации](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/configuration.md).
-
-Пакет `intlayer-editor` основан на Intlayer и доступен для JavaScript-приложений, таких как React (Create React App), Vite + React и Next.js.
-
-Для получения дополнительной информации о том, как установить пакет, смотрите соответствующий раздел ниже:
-
-### Интеграция с Next.js
-
-Для интеграции с Next.js обратитесь к [руководству по настройке](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/intlayer_with_nextjs_15.md).
-
-### Интеграция с Create React App
-
-Для интеграции с Create React App обратитесь к [руководству по настройке](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/intlayer_with_create_react_app.md)
-
-### Интеграция с Vite + React
-
-Для интеграции с Vite + React обратитесь к [руководству по настройке](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/intlayer_with_vite+react.md)
-
-### Пример интеграции
-
-Чтобы интегрировать визуальный редактор Intlayer в ваш React-проект, выполните следующие шаги:
-
-- Импортируйте компонент редактора Intlayer в ваше React-приложение:
-
-  ```tsx fileName="src/App.jsx"
-  import { IntlayerEditorProvider } from "intlayer-editor";
-  import { IntlayerProvider } from "react-intlayer";
-
-  export default function App() {
-    return (
-      <IntlayerProvider>
-        <IntlayerEditorProvider>
-          <IntlayerEditor>
-            {/* Ваше содержимое приложения здесь */}
-          </IntlayerEditor>
-        </IntlayerEditorProvider>
-      </IntlayerProvider>
-    );
-  }
-  ```
-
-- Импортируйте стили редактора Intlayer в ваше приложение Next.js:
-
-  ```tsx fileName="src/app/[locale]/layout.jsx"
-  import { IntlayerEditorStyles } from "intlayer-editor";
-
-  export default async function RootLayout({ children, params }) {
-    const { locale } = await params;
-    return (
-      <IntlayerClientProvider locale={locale}>
-        <IntlayerEditorProvider>
-          <html lang={locale}>
-            <body className={IntlayerEditorStyles}>{children}</body>
-          </html>
-        </IntlayerEditorProvider>
-      </IntlayerClientProvider>
-    );
-  }
-  ```
-
-## Использование редактора
-
-Когда редактор установлен, включен и запущен, вы можете просматривать каждое поле, индексируемое Intlayer, наведя курсор на ваш контент.
-
-![Наведение курсора на контент](https://github.com/aymericzip/intlayer/blob/main/docs/assets/intlayer_editor_hover_content.png)
-
-Если ваш контент выделен контуром, вы можете долго нажать на него, чтобы открыть панель редактирования.
-
-## История документа
-
-- 5.5.10 - 2025-06-29: Инициализация истории

package/docs/ru/packages/lynx-intlayer/index.md

@@ -1,83 +0,0 @@
----
-createdAt: 2025-03-13
-updatedAt: 2025-06-29
-title: Документация пакета | lynx-intlayer
-description: Узнайте, как использовать пакет lynx-intlayer
-keywords:
-  - Intlayer
-  - lynx-intlayer
-  - Интернационализация
-  - Документация
-  - Next.js
-  - JavaScript
-  - React
-slugs:
-  - doc
-  - packages
-  - lynx-intlayer
----
-
-# lynx-intlayer: Интернационализация (i18n) приложения Lynx
-
-**Intlayer** - это набор пакетов, разработанных специально для JavaScript-разработчиков. Он совместим с такими фреймворками, как React, React и Express.js.
-
-**Пакет `lynx-intlayer`** позволяет интернационализировать ваше приложение на Vite. В него включён плагин Metro, который настраивает конфигурацию через переменные окружения для [сборщика Lynx](https://lynxjs.org/index.html).
-
-## Зачем интернационализировать ваше приложение Lynx?
-
-Интернационализация вашего приложения Lynx необходима для эффективного обслуживания глобальной аудитории. Она позволяет вашему приложению предоставлять контент и сообщения на предпочитаемом языке каждого пользователя. Эта возможность улучшает пользовательский опыт и расширяет охват вашего приложения, делая его более доступным и релевантным для людей с разным языковым фоном.
-
-## Конфигурация
-
-Пакет `lynx-intlayer` отлично работает вместе с пакетом [`react-intlayer`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/packages/react-intlayer/index.md) и пакетом [`intlayer`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/packages/intlayer/index.md). Ознакомьтесь с соответствующей документацией для получения дополнительной информации.
-
-## Установка
-
-Установите необходимый пакет, используя предпочитаемый менеджер пакетов:
-
-```bash packageManager="npm"
-npm install lynx-intlayer
-```
-
-```bash packageManager="yarn"
-yarn add lynx-intlayer
-```
-
-```bash packageManager="pnpm"
-pnpm add lynx-intlayer
-```
-
-## Пример использования
-
-Пример того, как включить плагины в вашу конфигурацию vite.
-
-```ts
-// lynx.config.ts
-import { defineConfig } from "@lynx-js/rspeedy";
-import { pluginIntlayerLynx } from "lynx-intlayer/plugin";
-
-export default defineConfig({
-  plugins: [
-    // ... другие плагины
-    pluginIntlayerLynx(),
-  ],
-});
-```
-
-## Освоение интернационализации вашего приложения на Vite
-
-Intlayer предоставляет множество функций, которые помогут вам интернационализировать ваше приложение на Vite.
-
-**Чтобы узнать больше об этих функциях, обратитесь к руководству [React Internationalization (i18n) с Intlayer и Lynx](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/intlayer_with_lynx+react.md) для приложения Lynx.**
-
-## Узнайте больше об Intlayer
-
-- [Веб-сайт Intlayer](https://intlayer.org)
-- [Документация Intlayer](https://intlayer.org/doc)
-- [GitHub Intlayer](https://github.com/aymericzip/intlayer)
-
-- [Задайте свои вопросы нашей умной документации](https://intlayer.org/doc/chat)
-
-## История документации
-
-- 5.5.10 - 2025-06-29: Инициализация истории

package/docs/ru/packages/next-intlayer/index.md

@@ -1,285 +0,0 @@
----
-createdAt: 2025-08-23
-updatedAt: 2025-08-23
-title: Документация пакета | next-intlayer
-description: Узнайте, как использовать пакет next-intlayer
-keywords:
-  - Intlayer
-  - next-intlayer
-  - Интернационализация
-  - Документация
-  - Next.js
-  - JavaScript
-  - React
-slugs:
-  - doc
-  - packages
-  - next-intlayer
----
-
-# next-intlayer: NPM пакет для интернационализации (i18n) приложения Next.js
-
-**Intlayer** - это набор пакетов, разработанных специально для JavaScript-разработчиков. Он совместим с такими фреймворками, как React, Next.js и Express.js.
-
-**Пакет `next-intlayer`** позволяет интернационализировать ваше приложение Next.js. Он предоставляет провайдеры контекста и хуки для интернационализации в Next.js. Кроме того, в него входит плагин Next.js для интеграции Intlayer с [Webpack](https://webpack.js.org/) или [Turbopack](https://nextjs.org/docs/app/api-reference/turbopack), а также middleware для определения предпочтительной локали пользователя, управления cookies и обработки перенаправления URL.
-
-## Зачем интернационализировать ваше приложение Next.js?
-
-Интернационализация вашего приложения Next.js необходима для эффективного обслуживания глобальной аудитории. Она позволяет вашему приложению предоставлять контент и сообщения на предпочитаемом языке каждого пользователя. Эта возможность улучшает пользовательский опыт и расширяет охват вашего приложения, делая его более доступным и релевантным для людей с разным языковым фоном.
-
-## Зачем интегрировать Intlayer?
-
-- **Управление контентом на JavaScript**: Используйте гибкость JavaScript для эффективного определения и управления вашим контентом.
-- **Типобезопасная среда**: Используйте TypeScript, чтобы все определения контента были точными и безошибочными.
-- **Интегрированные файлы контента**: Держите переводы рядом с соответствующими компонентами, что повышает удобство поддержки и ясность.
-
-## Установка
-
-Установите необходимый пакет с помощью предпочитаемого менеджера пакетов:
-
-```bash packageManager="npm"
-npm install next-intlayer
-```
-
-```bash packageManager="yarn"
-yarn add next-intlayer
-```
-
-```bash packageManager="pnpm"
-pnpm add next-intlayer
-```
-
-## Пример использования
-
-С Intlayer вы можете объявлять свой контент в структурированном виде в любом месте вашего кода.
-
-По умолчанию Intlayer сканирует файлы с расширением `.content.{json,ts,tsx,js,jsx,mjs,mjx,cjs,cjx}`.
-
-> Вы можете изменить расширение по умолчанию, установив свойство `contentDir` в [файле конфигурации](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/configuration.md).
-
-```bash codeFormat="typescript"
-.
-├── intlayer.config.ts
-└── src
-    └── components
-        ├── ClientComponent
-        │   ├── index.content.ts
-        │   └── index.tsx
-        └── ServerComponent
-            ├── index.content.ts
-            └── index.tsx
-```
-
-```bash codeFormat="esm"
-.
-├── intlayer.config.mjs
-└── src
-    └── components
-        ├── ClientComponent
-        │   ├── index.content.mjs
-        │   └── index.mjx
-        └── ServerComponent
-            ├── index.content.mjs
-            └── index.mjx
-```
-
-```bash codeFormat="commonjs"
-.
-├── intlayer.config.cjs
-└── src
-    └── components
-        ├── ClientComponent
-        │   ├── index.content.cjs
-        │   └── index.cjx
-        └── ServerComponent
-            ├── index.content.cjs
-            └── index.cjx
-```
-
-### Объявите ваш контент
-
-`next-intlayer` создан для работы с пакетом [`intlayer`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/packages/intlayer/index.md). `intlayer` - это пакет, который позволяет объявлять ваш контент в любом месте кода. Он преобразует многоязычные объявления контента в структурированные словари, которые бесшовно интегрируются в ваше приложение.
-
-Вот пример объявления контента:
-
-```tsx fileName="src/ClientComponent/index.content.ts" codeFormat="typescript"
-import { t, type Dictionary } from "intlayer";
-
-const clientComponentContent = {
-  key: "client-component",
-  content: {
-    myTranslatedContent: t({
-      en: "Hello World",
-      es: "Hola Mundo",
-      fr: "Bonjour le monde",
-    }),
-    numberOfCar: enu({
-      "<-1": "Less than minus one car",
-      "-1": "Минус одна машина",
-      "0": "Нет машин",
-      "1": "Одна машина",
-      ">5": "Несколько машин",
-      ">19": "Много машин",
-    }),
-  },
-} satisfies Dictionary;
-
-export default clientComponentContent;
-```
-
-```jsx fileName="src/ClientComponent/index.content.mjs" contentDeclarationFormat="esm"
-import { t } from "intlayer";
-
-/** @type {import('intlayer').Dictionary} */
-const clientComponentContent = {
-  key: "client-component",
-  content: {
-    myTranslatedContent: t({
-      en: "Hello World",
-      es: "Hola Mundo",
-      fr: "Bonjour le monde",
-    }),
-    numberOfCar: enu({
-      "<-1": "Меньше чем минус одна машина",
-      "-1": "Минус одна машина",
-      "0": "Нет машин",
-      "1": "Одна машина",
-      ">5": "Несколько машин",
-      ">19": "Много машин",
-    }),
-  },
-};
-
-export default clientComponentContent;
-```
-
-```jsx fileName="src/ClientComponent/index.content.cjs" contentDeclarationFormat="commonjs"
-const { t } = require("intlayer");
-
-/** @type {import('intlayer').Dictionary} */
-const clientComponentContent = {
-  key: "client-component",
-  content: {
-    myTranslatedContent: t({
-      en: "Hello World",
-      es: "Hola Mundo",
-      fr: "Bonjour le monde",
-    }),
-    numberOfCar: enu({
-      "<-1": "Меньше чем минус одна машина",
-      "-1": "Минус одна машина",
-      "0": "Нет машин",
-      "1": "Одна машина",
-      ">5": "Несколько машин",
-      ">19": "Много машин",
-    }),
-  },
-};
-
-module.exports = clientComponentContent;
-```
-
-```json fileName="src/ClientComponent/index.content.json" codeFormat="json"
-{
-  "key": "client-component",
-  "content": {
-    "myTranslatedContent": {
-      "nodeType": "translation",
-      "translation": {
-        "en": "Hello World",
-        "fr": "Bonjour le monde",
-        "es": "Hola Mundo"
-      }
-    },
-    "numberOfCar": {
-      "nodeType": "enumeration",
-      "enumeration": {
-        "<-1": "Меньше чем минус одна машина",
-        "-1": "Минус одна машина",
-        "0": "Нет машин",
-        "1": "Одна машина",
-        ">5": "Несколько машин",
-        ">19": "Много машин"
-      }
-    }
-  }
-}
-```
-
-### Использование контента в вашем коде
-
-После того, как вы объявили свой контент, вы можете использовать его в своем коде. Вот пример того, как использовать контент в React-компоненте:
-
-```tsx {4,7} fileName="src/components/ClientComponentExample.tsx" codeFormat="typescript"
-"use client";
-
-import type { FC } from "react";
-import { useIntlayer } from "next-intlayer";
-
-export const ClientComponentExample: FC = () => {
-  const { myTranslatedContent } = useIntlayer("client-component"); // Создать связанное объявление контента
-
-  return (
-    <div>
-      <p>{myTranslatedContent}</p>
-    </div>
-  );
-};
-```
-
-```jsx {3,6} fileName="src/components/ClientComponentExample.mjx" codeFormat="esm"
-"use client";
-
-import { useIntlayer } from "next-intlayer";
-
-const ClientComponentExample = () => {
-  const { myTranslatedContent } = useIntlayer("client-component"); // Создать связанное объявление контента
-
-  return (
-    <div>
-      <p>{myTranslatedContent}</p>
-    </div>
-  );
-};
-```
-
-```jsx {3,6} fileName="src/components/ClientComponentExample.csx" codeFormat="commonjs"
-"use client";
-
-const { useIntlayer } = require("next-intlayer");
-
-const ClientComponentExample = () => {
-  const { myTranslatedContent } = useIntlayer("client-component"); // Создать связанное объявление контента
-
-  return (
-    <div>
-      <p>{myTranslatedContent}</p>
-    </div>
-  );
-};
-```
-
-## Освоение интернационализации вашего приложения Next.js
-
-Intlayer предоставляет множество функций, которые помогут вам интернационализировать ваше приложение Next.js. Вот некоторые из ключевых возможностей:
-
-- **Интернационализация серверных компонентов**: Intlayer позволяет интернационализировать ваши серверные компоненты так же, как и клиентские. Это означает, что вы можете использовать одни и те же объявления контента как для клиентских, так и для серверных компонентов.
-- **Промежуточное ПО для определения локали**: Intlayer предоставляет промежуточное ПО для определения предпочтительной локали пользователя. Это промежуточное ПО используется для определения предпочтительной локали пользователя и перенаправления его на соответствующий URL, как указано в [конфигурации](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/configuration.md).
-- **Интернационализация метаданных**: Intlayer предоставляет способ интернационализировать ваши метаданные, такие как заголовок страницы, используя функцию `generateMetadata`, предоставляемую Next.js. Вы можете использовать функцию `getTranslation` для перевода ваших метаданных.
-- **Интернационализация sitemap.xml и robots.txt**: Intlayer позволяет интернационализировать ваши файлы sitemap.xml и robots.txt. Вы можете использовать функцию `getMultilingualUrls` для генерации многоязычных URL-адресов для вашей карты сайта.
-- **Интернационализация URL-адресов**: Intlayer позволяет интернационализировать ваши URL-адреса с помощью функции `getMultilingualUrls`. Эта функция генерирует многоязычные URL-адреса для вашей карты сайта.
-
-**Чтобы узнать больше об этих функциях, обратитесь к руководству [Next.js Internationalization (i18n) с Intlayer и Next.js 15 App Router](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/intlayer_with_nextjs_15.md).**
-
-## Функции, предоставляемые пакетом `next-intlayer`
-
-Пакет `next-intlayer` также предоставляет некоторые функции, которые помогут вам интернационализировать ваше приложение.
-
-- [`t()`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/packages/next-intlayer/t.md)
-- [`useIntlayer()`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/packages/next-intlayer/useIntlayer.md)
-- [`useDictionary()`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/packages/next-intlayer/useDictionary.md)
-- [`useLocale()`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/packages/next-intlayer/useLocale.md)
-
-## История документации
-
-- 5.5.10 - 2025-06-29: Инициализация истории

package/docs/ru/packages/nuxt-intlayer/index.md

@@ -1,53 +0,0 @@
----
-createdAt: 2025-06-18
-updatedAt: 2025-06-29
-title: Документация пакета | nuxt-intlayer
-description: Узнайте, как использовать пакет nuxt-intlayer
-keywords:
-  - Intlayer
-  - nuxt-intlayer
-  - Интернационализация
-  - Документация
-  - JavaScript
-  - Nuxt
-slugs:
-  - doc
-  - packages
-  - nuxt-intlayer
----
-
-# nuxt-intlayer: NPM пакет для интернационализации (i18n) приложения на Vue
-
-**Intlayer** - это набор пакетов, разработанных специально для JavaScript-разработчиков. Он совместим с такими фреймворками, как Vue, Vue и Express.js.
-
-**Пакет `nuxt-intlayer`** позволяет интернационализировать ваше приложение на Vue. Он предоставляет провайдеры контекста и хуки для интернационализации Vue.
-
-## Зачем интернационализировать ваше приложение на Vue?
-
-Интернационализация вашего приложения на Vue необходима для эффективного обслуживания глобальной аудитории. Она позволяет вашему приложению предоставлять контент и сообщения на предпочитаемом языке каждого пользователя. Эта возможность улучшает пользовательский опыт и расширяет охват вашего приложения, делая его более доступным и релевантным для людей с разными языковыми предпочтениями.
-
-## Почему стоит интегрировать Intlayer?
-
-- **Управление контентом на базе JavaScript**: Используйте гибкость JavaScript для эффективного определения и управления вашим контентом.
-- **Типобезопасная среда**: Используйте TypeScript, чтобы гарантировать точность и отсутствие ошибок во всех определениях вашего контента.
-- **Интегрированные файлы контента**: Держите ваши переводы рядом с соответствующими компонентами, что повышает удобство поддержки и ясность.
-
-## Установка
-
-Установите необходимый пакет с помощью предпочитаемого менеджера пакетов:
-
-```bash packageManager="npm"
-npm install nuxt-intlayer
-```
-
-```bash packageManager="yarn"
-yarn add nuxt-intlayer
-```
-
-```bash packageManager="pnpm"
-pnpm add nuxt-intlayer
-```
-
-## История документации
-
-- 5.5.10 - 2025-06-29: Инициализация истории

package/docs/ru/packages/preact-intlayer/index.md

@@ -1,53 +0,0 @@
----
-createdAt: 2025-04-18
-updatedAt: 2025-06-29
-title: Документация пакета | preact-intlayer
-description: Узнайте, как использовать пакет preact-intlayer
-keywords:
-  - Intlayer
-  - preact-intlayer
-  - Интернационализация
-  - Документация
-  - JavaScript
-  - Preact
-slugs:
-  - doc
-  - packages
-  - preact-intlayer
----
-
-# preact-intlayer: NPM-пакет для интернационализации (i18n) приложения на Preact
-
-**Intlayer** - это набор пакетов, разработанных специально для JavaScript-разработчиков. Он совместим с такими фреймворками, как Preact, Preact и Express.js.
-
-**Пакет `preact-intlayer`** позволяет интернационализировать ваше приложение на Preact. Он предоставляет провайдеры контекста и хуки для интернационализации в Preact.
-
-## Зачем интернационализировать ваше приложение на Preact?
-
-Интернационализация вашего приложения на Preact необходима для эффективного обслуживания глобальной аудитории. Она позволяет вашему приложению предоставлять контент и сообщения на предпочитаемом языке каждого пользователя. Эта возможность улучшает пользовательский опыт и расширяет охват вашего приложения, делая его более доступным и релевантным для людей с разным языковым фоном.
-
-## Почему стоит интегрировать Intlayer?
-
-- **Управление контентом на базе JavaScript**: Используйте гибкость JavaScript для эффективного определения и управления вашим контентом.
-- **Типобезопасная среда**: Используйте TypeScript, чтобы все определения контента были точными и безошибочными.
-- **Интегрированные файлы контента**: Держите переводы рядом с соответствующими компонентами, что улучшает поддерживаемость и ясность.
-
-## Установка
-
-Установите необходимый пакет, используя предпочитаемый менеджер пакетов:
-
-```bash packageManager="npm"
-npm install preact-intlayer
-```
-
-```bash packageManager="yarn"
-yarn add preact-intlayer
-```
-
-```bash packageManager="pnpm"
-pnpm add preact-intlayer
-```
-
-## История документации
-
-- 5.5.10 - 2025-06-29: Инициализация истории