markdown-tocは、mdファイル内の見出し記法(#)を元に、目次を自動作成するパッケージです。
というわけで、今日はAtomのmarkdown-tocのインストール方法と使用方法の説明です。
なおTOCとはTable of Contentsの略で、目次のことです。
インストール方法
インストール方法は、以下のとおりです。
- メニューバーの[ファイル] → [設定] → [インストール]とクリックし、
- パッケージのインストール画面で、markdown-toc と入力し、
- [Install]ボタンをクリック。
使用方法
目次を入れたい位置に、カーソルを移動して、以下のいずれかの方法で、目次を挿入します。
- メニューバー → markdown-toc → toggle
- コマンドパレットで、markdown toc toggle を入力
なお上記の方法を、一度実行すると、次からはコマンドパレットから、以下のコマンドを使って、目次の削除・作成・更新を行います。
- markdown-toc:delete (目次の削除)
- markdown-toc:create (目次の作成)
- markdown-toc:update (目次の更新)
では、すこし補足を。
目次の削除
目次の削除を行うには、以下のいずれかの方法で行います。
- コマンドパレットで、markdown toc delete を入力
- ctrl + alt + r
目次の作成
目次の作成を行うには、以下のいずれかの方法で行います。
- コマンドパレットで、markdown toc create を入力
- ctrl + alt + c
目次の更新
markdown-tocには、オプションがあります。<!– TOC depthFrom:1 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 –>内に書かれているオプション値を変更することによって、目次作成の設定を変更することが可能です。
変更方法は以下のとおりです。
- 設定オプションの変更をして、
- コマンドパレットで markdown-toc:update 又は ctrl + alt + u
なお、オプションの設定は、以下のとおりです。
depthFrom:
いくつのレベル(h1～h6)見出しから、目次に含めるかをさせるか を設定します
たとえば、depthFrom:2 にすると、#(=h1)を目次に含めません
depthTo:
いくつのレベル(h1～h6)見出しまで、目次に含めるか を設定します
たとえば、depthTo:2 にすると、##(=h2)までしか目次に含めません
例をいくつか示しますね。
- depthFrom:2 depthTo:2 ##(=h2) しか、目次に含めません
- depthFrom:2 depthTo:3 ##(=h2) と ###(=h3) しか、目次に含めません
withLinks:
目次に、見出しへのリンクをつけるか を設定します
- 0 つけない
- 1 つける(デフォルト)
updateOnSave:
mdファイルを保存するたびに、目次を更新するか を設定します
- 0 更新しない
- 1 更新する(デフォルト)
たとえば、updateOnSave:1(更新する)にすると、見出し(#)の文言を更新して、保存すると、自動的に、目次も更新されます。
orderedList:
目次をナンバリングにするか を設定します
- 0 ナンバリングにしない =<ul> (デフォルト)
- 1 ナンバリングにする =<ol>
問題点
markdown-tocを一度実行すると、他のファイルで、markdown-tocが利用できなくなります。Atomを再起動すれば、利用できるようになるのですが…これは管理人の環境だけなのか、それともバグなのか…
あと日本語の見出しには、リンクできない(移動しない)ことです。なにかやり方あるのでしょうか…
以上です。