Mintlify

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.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {
    "mdx": {
      "include": ["[locale]/*.mdx", "[locale]/*/*.mdx"]
    }
  }
}

このファイルは以下を定義します：

• Lingo.dev CLIが翻訳すべきファイル
• 翻訳する言語間

この場合、設定はMDXファイルを英語からスペイン語に翻訳します。

重要な注意点：

• [locale]は実行時に置き換えられるプレースホルダーです。これにより、コンテンツが一つの場所（例：en/index.mdx）から読み込まれ、別の場所（例：es/index.mdx）に書き込まれることを保証します。
• Lingo.dev CLIは再帰的なグロブパターン（例：**/*.mdx）をサポートしていません。ネストされたディレクトリ内に存在するファイルを翻訳するには、追加のincludeパターンを作成する必要があります。

詳細については、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がサポートする言語のサブセットのみをサポートしています。執筆時点では、以下の表にリストが含まれています。最新のリストについては、公式ドキュメントを参照してください。