ゆるふわエンジニアのブログ

行ったこと、調べたこと等をつらつらと書いていくかもしれません。

Markdownファイルの目次を自動生成する方法

本記事では、doctocを使用してMarkdownファイルの目次を自動生成する方法を説明します。

本記事の内容です。

対象読者

  • Markdownで記述したドキュメントの目次を自動生成したい方

前提条件

お使いのPCにNode.jsをインストールしていること。

doctocをインストール

下記のコマンドを実行します。

npm install -g doctoc

目次を自動生成

目次を作成したいMarkdownファイルが存在するディレクトリをパラメータに指定し、doctocコマンドを実行します。
下記は、カレントディレクトリを指定しています。

doctoc .



「Everything is OK.」が表示されるまで待ち、その後、ファイルを開いてみると先頭に

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

に囲まれて、目次が生成されているのを確認することができます。
あとはそれらをコピーし、自由にお使いください。


ちなみに、本記事の目次は下記の形で出力されました。

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*

- [対象読者](#%E5%AF%BE%E8%B1%A1%E8%AA%AD%E8%80%85)
- [前提条件](#%E5%89%8D%E6%8F%90%E6%9D%A1%E4%BB%B6)
- [目次](#%E7%9B%AE%E6%AC%A1)
- [doctocをインストール](#doctoc%E3%82%92%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB)
- [目次を自動生成](#%E7%9B%AE%E6%AC%A1%E3%82%92%E8%87%AA%E5%8B%95%E7%94%9F%E6%88%90)
- [参考](#%E5%8F%82%E8%80%83)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

参考

github.com