> ## Documentation Index
> Fetch the complete documentation index at: https://koharu.rs/llms.txt
> Use this file to discover all available pages before exploring further.

# ドキュメントの編集と公開

> Mintlify をプレビューし、翻訳 MDX と公開設定を管理します。

ドキュメントは `packages/docs/` 内の Mintlify ワークスペース `@koharu/docs` です。依存関係はリポジトリのルートにある `bun.lock` で管理します。

<Steps>
  <Step title="ツールを導入する">
    Node.js 24 LTS と Bun 1.3.14 以降を使い、リポジトリのルートから実行します。

    ```bash theme={null}
    bun install --frozen-lockfile --ignore-scripts
    ```
  </Step>

  <Step title="プレビューする">
    ```bash theme={null}
    bun run docs
    ```

    `http://localhost:3001` を開きます。MDX や設定を変更すると表示が更新されます。
  </Step>
</Steps>

## ネイティブ 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 設定に従います。

<Note>公開とドメイン有効化には Mintlify の GitHub 連携とドメイン設定が必要です。</Note>

Mintlify の [monorepo 設定](https://www.mintlify.com/docs/deploy/monorepo)と[カスタムドメイン](https://www.mintlify.com/docs/customize/custom-domain)を参照してください。