Mintlify

Что такое Mintlify?

Mintlify — это платформа для документации, которая создает красивые и настраиваемые сайты документации. Она предоставляет встроенный поиск, аналитику и функции для работы с API, чтобы создавать современную документацию для разработчиков.

Что такое Lingo.dev CLI?

Lingo.dev — это платформа перевода на основе искусственного интеллекта. Lingo.dev CLI считывает исходные файлы, отправляет переводимый контент в крупные языковые модели и записывает переведенные файлы обратно в ваш проект.

О данном руководстве

Это руководство объясняет, как настроить Lingo.dev CLI на сайте документации Mintlify. Вы узнаете, как создать проект с Mintlify, настроить процесс перевода и просмотреть результаты.

Шаг 1. Настройка проекта Mintlify

1. Установите Mintlify CLI:

   npm i -g mint
   

2. Клонируйте стартовый шаблон Mintlify:

   git clone https://github.com/mintlify/starter.git
   

3. Перейдите в каталог проекта:

   cd starter
   

Шаг 2. Создание исходного контента

1. Создайте каталог для хранения документации на исходном языке:

   mkdir en
   

2. Создайте файл, содержащий некоторый контент документации (например, en/overview.mdx):

   ---
   title: "Введение"
   description: "Добро пожаловать в новый дом для вашей документации"
   ---
   
   ## Начало работы
   
   Эта документация автоматически переведена с помощью Lingo.dev.
   
   ## Возможности
   
   Наш продукт включает мощные функции для современного развития.
   

Шаг 3. Настройка CLI

В корне проекта создайте файл i18n.json:

{
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": 1.8,
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {
    "mdx": {
      "include": ["[locale]/*.mdx", "[locale]/*/*.mdx"]
    }
  }
}

Этот файл определяет:

• файлы, которые должен переводить Lingo.dev CLI
• языки для перевода

В данном случае конфигурация переводит файлы MDX с английского на испанский.

Важно отметить, что:

• [locale] — это заполнитель, который заменяется во время выполнения на настроенные локали. При использовании корзины MDX заполнитель должен быть включен во все настроенные шаблоны include.
• Lingo.dev CLI не поддерживает рекурсивные шаблоны glob. Вам нужно будет создать дополнительные шаблоны include, если вы создаете контент в более глубоких каталогах.

Чтобы узнать больше о файле i18n.json, смотрите конфигурацию i18n.json.

Шаг 4. Переведите контент

1. Зарегистрируйтесь в Lingo.dev.

2. Войдите в Lingo.dev через CLI:

   npx lingo.dev@latest login
   

3. Запустите процесс перевода:

   npx lingo.dev@latest run
   

   CLI создаст директорию es/ для хранения переведенного контента и файл i18n.lock для отслеживания переведенного (чтобы избежать ненужных повторных переводов).

Шаг 5. Используйте переводы

1. В файле docs.json добавьте свойство languages в объект navigation:

   {
     "navigation": {
       "languages": []
     }
   }
   

2. Для каждого поддерживаемого языка добавьте отдельный объект в массив:

   {
     "navigation": {
       "languages": [
         {
           "language": "en",
           "groups": [
             {
               "group": "Getting started",
               "pages": ["en/overview"]
             }
           ]
         },
         {
           "language": "es",
           "groups": [
             {
               "group": "Getting started",
               "pages": ["es/overview"]
             }
           ]
         }
       ]
     }
   }
   

   Обратите внимание:

   • Вам нужно будет воспроизвести всю структуру навигации отдельно для каждого языка.
   • Mintlify поддерживает только ограниченный набор языков, которые поддерживает CLI Lingo.dev.

3. Запустите сервер разработки:

   mint dev
   

4. Перейдите на http://localhost:3000. Вы должны увидеть выпадающий список для переключения между языками.

Известные ограничения

• Любой текст пользовательского интерфейса, определенный в файле docs.json (например, метки групп в боковой панели, текст-заполнитель поиска и т. д.), не будет переведен.

Поддерживаемые языки

Mintlify поддерживает только ограниченный набор языков, которые поддерживает CLI Lingo.dev. На момент написания этот список выглядит следующим образом. Для получения актуального списка смотрите официальную документацию.