Документация Intlayer
Добро пожаловать в документацию Intlayer. Этот гид предоставляет обзор Intlayer, его основных функций и того, как эффективно использовать эти документы для улучшения вашего опыта разработки.
Введение
Что такое Intlayer?
Intlayer — это библиотека интернационализации, специально созданная для разработчиков на JavaScript. Она позволяет декларацию вашего контента везде в вашем коде. Она преобразует декларацию многоязычного контента в структурированные словари, которые легко интегрировать в ваш код. Используя TypeScript, Intlayer делает вашу разработку более надежной и эффективной.
Intlayer также предоставляет необязательный визуальный редактор, который позволяет вам легко редактировать и управлять вашим контентом. Этот редактор особенно полезен для разработчиков, которые предпочитают визуальный интерфейс для управления контентом, или для команд, создающих контент, не беспокоясь о коде.
Пример использования
.└── Components └── MyComponent ├── index.content.ts └── index.tsx
import { type DeclarationContent, t } from "intlayer";const componentContent = { key: "component-key", content: { myTranslatedContent: t({ en: "Hello World", fr: "Bonjour le monde", es: "Hola Mundo", }), },} satisfies DeclarationContent;export default componentContent;
import type { FC } from "react";import { useIntlayer } from "react-intlayer";export const MyComponent: FC = () => { const { myTranslatedContent } = useIntlayer("component-key"); return <span>{myTranslatedContent}</span>; // Отображаем переведенный контент};
Основные функции
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