Mintlify

Lingo.dev CLIによるMintlifyのAI翻訳

Mintlifyとは？

Mintlifyは、美しくカスタマイズ可能なドキュメンテーションサイトを作成するドキュメンテーションプラットフォームです。最新の開発者向けドキュメントを構築するための検索機能、分析機能、APIプレイグラウンド機能が組み込まれています。

Lingo.dev CLIとは？

Lingo.devはAI駆動の翻訳プラットフォームです。Lingo.dev CLIはソースファイルを読み込み、翻訳可能なコンテンツを大規模言語モデルに送信し、翻訳されたファイルをプロジェクトに書き戻します。

このガイドについて

このガイドでは、MintlifyドキュメンテーションサイトでLingo.dev CLIをセットアップする方法を説明します。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は再帰的なグロブパターンをサポートしていません。より深いディレクトリにコンテンツを作成する場合は、追加のincludeパターンを作成する必要があります。

i18n.jsonファイルの詳細については、i18n.json設定を参照してください。

ステップ 4. コンテンツを翻訳する

  1. Lingo.devアカウントにサインアップしてください。

  2. CLIを通じてLingo.devにログインします：

    npx lingo.dev@latest login

  3. 翻訳パイプラインを実行します：

    npx lingo.dev@latest run

    CLIは翻訳されたコンテンツを保存するためのes/ディレクトリと、翻訳済みの内容を追跡するためのi18n.lockファイル（不要な再翻訳を防ぐため）を作成します。

ステップ 5. 翻訳を使用する

  1. docs.jsonファイルで、navigationオブジェクトにlanguagesプロパティを追加します：

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

  2. サポートする各言語について、配列に個別のオブジェクトを追加します：

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

    注意点：

    • 各言語ごとにナビゲーション構造全体を個別に複製する必要があります。
    • MintlifyはLingo.dev CLIがサポートする言語のサブセットのみをサポートしています。

  3. 開発サーバーを起動します：

    mint dev

  4. http://localhost:3000 にアクセスします。言語を切り替えるためのドロップダウンが表示されるはずです。

既知の制限事項

  • docs.jsonファイルで定義されているUIコピー（サイドバーのグループラベル、検索プレースホルダーテキストなど）は翻訳されません。

サポートされている言語

MintlifyはLingo.dev CLIがサポートする言語のサブセットのみをサポートしています。執筆時点では、以下の表にリストが含まれています。最新のリストについては、公式ドキュメントを参照してください。

言語コード
アラビア語ar
中国語cn
中国語（繁体字）zh-Hant
英語en
フランス語fr
ドイツ語de
インドネシア語id
イタリア語it
日本語jp
韓国語ko
ポルトガル語（ブラジル）pt-BR
ロシア語ru
スペイン語es
トルコ語tr