Документация Intlayer

Добро пожаловать в документацию Intlayer. Этот гид предоставляет обзор Intlayer, его основных функций и как эффективно использовать эти документы для улучшения вашего опыта разработки.

Введение

Что такое Intlayer?

Intlayer — это библиотека интернационализации, специально разработанная для разработчиков JavaScript. Она позволяет объявлять ваш контент повсюду в вашем коде. Она преобразует объявления многоязычного контента в структурированные словари для легкой интеграции в ваш код. Используя TypeScript, Intlayer делает вашу разработку более надежной и эффективной.

Intlayer также предоставляет необязательный визуальный редактор, который позволяет вам легко редактировать и управлять вашим контентом. Этот редактор особенно полезен для разработчиков, которые предпочитают визуальный интерфейс для управления контентом, или для команд, генерирующих контент, не беспокоясь о коде.

Пример использования

bash

1.
2├── ClientComponent
3│   ├── index.content.ts
4│   └── index.tsx
5└── ServerComponent
6    ├── index.content.ts
7    └── index.tsx

tsx

1// ./ClientComponent/index.content.ts
2
3import { type DeclarationContent, t } from "intlayer";
4
5const clientComponentContent = {
6  key: "client-component",
7  content: {
8    myTranslatedContent: t({
9      en: "Hello World",
10      fr: "Bonjour le monde",
11      es: "Hola Mundo",
12    }),
13  },
14} satisfies DeclarationContent;
15
16export default clientComponentContent;

tsx

1// ./ClientComponent/index.tsx
2"use client";
3
4import { useIntlayer } from "next-intlayer";
5
6export const ClientComponent = () => {
7  const { myTranslatedContent } = useIntlayer("client-component");
8
9  return <span>{myTranslatedContent}</span>;
10};

Основные функции

Intlayer предлагает множество функций, адаптированных для современных нужд веб-разработки. Ниже приведены ключевые функции с ссылками на детализированную документацию по каждой из них:

Поддержка интернационализации: Расширьте глобальный охват вашего приложения с помощью встроенной поддержки интернационализации.
Визуальный редактор: Улучшите рабочий процесс разработки с помощью плагинов редактора, разработанных для Intlayer. Ознакомьтесь с Руководством по визуальному редактору.
Гибкость конфигурации: Настройте вашу среду с обширными параметрами конфигурации, описанными в Руководстве по конфигурации.
Расширенные инструменты CLI: Эффективно управляйте вашими проектами, используя интерфейс командной строки Intlayer. Изучите функциональные возможности в Документации по инструментам CLI.
Совместимость с i18n: Intlayer работает без проблем с другими библиотеками интернационализации. Ознакомьтесь с Руководством по i18n для получения дополнительной информации.

Поддерживаемые платформы

Intlayer разработан для безупречной работы с приложениями Next.js и React. Он также поддерживает Vite и Create React App.

Интеграция с Next.js: Используйте мощь Next.js в Intlayer для рендеринга на стороне сервера и генерации статических сайтов. Подробности доступны в нашем Руководстве по интеграции с Next.js.
Интеграция с Vite и React: Используйте Vite в Intlayer для рендеринга на стороне сервера и генерации статических сайтов. Подробности доступны в нашем Руководстве по интеграции с Vite и React.
Интеграция с Create React App: Используйте мощь Create React App в Intlayer для рендеринга на стороне сервера и генерации статических сайтов. Подробности доступны в нашем Руководстве по интеграции с Create React App.

Как использовать эту документацию

Чтобы получить максимальную пользу от этой документации:

Перейдите к соответствующим разделам: Используйте предоставленные выше ссылки, чтобы перейти непосредственно к разделам, которые соответствуют вашим потребностям.
Интерактивные примеры: Где это возможно, используйте интерактивные примеры, чтобы увидеть, как функции работают в реальном времени.
Обратная связь и вклады: Ваша обратная связь важна. Если у вас есть предложения или исправления, пожалуйста, подумайте о том, чтобы внести свой вклад в документацию.

Если у вас есть идея по улучшению этой документации, не стесняйтесь внести свой вклад, подав запрос на вытягивание на GitHub.

Ссылка на документацию GitHub

Как работает Intlayer