メインコンテンツまでスキップ

設定をカスタマイズするには

このページでは、annai（ソースコードからユーザー向けマニュアルを自動生成するツール）の設定ファイルを編集し、マニュアル生成の動作をプロジェクトに合わせて調整します。

手順​

  1. プロジェクトのルートフォルダにある annai.config.json（annai の設定ファイル、JSON（データ記述形式）で記述されています）をテキストエディタで開きます。

  2. siteName の値を変更します。この値は、マニュアルサイトのタイトルとしてページ上部に表示されます。

    {
      "siteName": "My App ユーザーガイド"
    }

  3. 必要に応じて、その他の設定項目も変更します。主な設定項目は以下の通りです。

    項目説明
    sourcePath解析対象のソースコードフォルダです
    outputPathマニュアルの出力先フォルダです
    sourceExtensions解析対象のファイル拡張子です
    excludeDirs解析から除外するフォルダです
    cloudflare.projectNameCloudflare Pages（Web サイトのホスティングサービス）のプロジェクト名です

  4. ファイルを保存し、以下のコマンドで設定が反映されているか確認します。

    annai gen --dry-run

ここまでの手順が完了すると、プロジェクトに合わせた設定で annai を使える状態になります。

警告

annai.config.json の書式に誤りがあると、annai は初期設定の値を使って動作します。 「annai.config.json のパースに失敗しました」というメッセージが表示された場合は、カンマの過不足、ダブルクォーテーションの閉じ忘れ、中括弧や角括弧の対応を確認します。 修正が難しい場合は、ファイルを削除して annai init で再生成します。

関連ページ​