GitBook の SUMMARY.md を自動生成する

プラグインを使って SUMMARY.md を自動生成できたので、メモしておきます。 `gitbook-summary` というプラグインを使用します。 - https://github.com/imfly/gitbook-summary 説明を見れば大体使い方はわかりますが、実際に使う上でいろいろはまった箇所もあるので、以下にまとめます。 ## 基本的な使い方 ドキュメントのルートで以下のコマンドを実行します。 ```sh book sm ``` ## 目次の並びを調整する 目次の並びはフォルダ名とファイル名に依存します。 従って、プレフィックスとして数字やアルファベットなどを付けて調整するわけですが、目次にはそのプレフィックスを表示したくない場合、デリミターを `book.json` に記述します。 例えば、以下のようにです。 ```json { "sortedBy": "-" } ``` ## ドキュメントのルートフォルダを指定する際の注意事項 コマンド実行時に、以下のようにドキュメントのルートフォルダを指定できます。 ```sh book sm -r src ``` このときの注意点として、`gitbook-summary` 用の `book.json` は指定したルートフォルダ内に置いておく必要があります。 従って、GitBook のルートと `gitbook-summary` のルートが異なる場合は、それぞれに `book.json` を用意する必要があります。 ルートが同じであれば `book.json` は一つにまとめることができます。 ## 参考 URL - https://github.com/imfly/gitbook-summary