packages/docs/ 内の Mintlify ワークスペース @koharu/docs です。依存関係はリポジトリのルートにある bun.lock で管理します。
1
ツールを導入する
Node.js 24 LTS と Bun 1.3.14 以降を使い、リポジトリのルートから実行します。
2
プレビューする
http://localhost:3001 を開きます。MDX や設定を変更すると表示が更新されます。ネイティブ MDX を書く
各ページの frontmatter にtitle と description を設定します。通常の記事のタイトルは Mintlify が描画するため、H1 として重複させません。ランディングページは Almond の標準 frame モードを使い、本文に H1 を 1 つ設けます。
手順には Steps、OS やモデルの選択肢には Tabs、必要な補足には Note・Tip・Warning、次の行動には Card、症状別の回答には Accordion を使います。表と Mermaid のコードフェンスを使い、独自のスクリプトや CSS に依存させません。
内部リンクは /ja/guides/export のようにルート相対で拡張子を省きます。共有画像は言語フォルダーの外へ置き、内容を説明する alt テキストを付けます。
翻訳をそろえる
英語はen/、日本語は ja/、簡体字中国語は zh/ にあります。スラッグ、操作手順、例、技術情報を 3 言語でそろえます。本文だけでなく見出し、説明、部品ラベル、ナビゲーション、画像説明も翻訳します。
テーマとナビゲーションは packages/docs/docs.json が担当します。ページを追加したら全言語のナビゲーションへ登録します。言語切り替えは Mintlify の標準機能を使い、旧 Zensical のルートやリダイレクトは残しません。
公開を接続する
Mintlify ダッシュボードでkoharu-rs/koharu を接続し、公開ブランチを選びます。Git Settings の docs.json is in a subdirectory を有効にして、末尾のスラッシュなしで /packages/docs を入力します。カスタムドメインに koharu.rs を指定し、Mintlify に表示された DNS 設定に従います。
公開とドメイン有効化には Mintlify の GitHub 連携とドメイン設定が必要です。