Mintlifyの標準機能を使って、英語(デフォルト)と日本語の2言語に対応したドキュメントサイトを構築する方法をご紹介します。
実際に、Cursorのドキュメント(docs.cursor.com)のように、洗練された言語切り替え機能を実装することがゴールです。
Mintlifyの多言語対応は、主な手順は以下の2つだけです。
docs.json
に対応言語の定義を追加する公式ドキュメント: Languages - Navigation - Mintlify
docs.json
の設定まず、プロジェクトのルートにある設定ファイル docs.json
を編集します。
ファイルのトップレベルに languages
というプロパティを追加し、対応したい言語の配列を定義します。
今回は英語(en)と日本語(ja)に対応させるため、以下のように記述します。配列の最初の言語がデフォルト言語として扱われます。
{
"navigation": {
"languages": [
{
"language": "en",
"groups": [
{
"group": "Getting started",
"pages": ["en/overview", "en/quickstart", "en/development"]
}
]
},
{
"language": "ja",
"groups": [
{
"group": "Getting started",
"pages": ["ja/overview", "ja/quickstart", "ja/development"]
}
]
}
]
}
}
この設定を追加するだけで、サイトのヘッダーに言語切り替えセレクタが自動的に表示されます。
次に、上記の docs.json
に設定したドキュメントファイルを配置します。
実際に私がこの手順で多言語対応を行った際のPull Requestを共有します。具体的なファイル差分を確認できるので、より理解が深まるかと思います。
Mintlifyを使えば、docs.json
への数行の追加と、言語ごとのディレクトリ作成という非常にシンプルな手順で、本格的な多言語対応ドキュメントサイトを構築できます。
フレームワーク側が国際化(i18n)の仕組みをうまく抽象化してくれているため、開発者はコンテンツの翻訳に集中できます。もしあなたのプロジェクトが世界中のユーザーを対象としているなら、ぜひこの機能を使ってドキュメントの多言語化に挑戦してみてください。
以上、Mintlifyでドキュメントサイトを多言語対応した、現場からお送りしました。