Markdown Markdown TOC Visual Studio Code

Markdown TOCのすすめ

Markdown PDFを使えば、PDF出力ができます。目次（Table of contents、TOC）を生成できれば更に便利です。 AlanWalkさんの作成した[Markdown TOC](https://github.com/AlanWalk/Markdown-TOC)を使ってみます。  ## 使い方 正常にインストールされると、右クリックで以下のようなメニューが表示されます。 * Markdown Sections:Delete * セクション（1.1などの記載）を削除します * Markdown Sections:Insert/Updata * セクションを生成、もしくは更新します。 * 目次は追加しませんので、目次が作成されていない時には何も起こりません。 * Markdown TOC:Delete * 目次を削除します。 * Markdown TOC:Insert/Updata * 目次を追加します。 * 複数作成することはできないようです。 以下のような文書があったとします。 ```markdown # タイトル ## 目次 ## 概要 ### 節1 ### 節2 ``` 「Markdown TOC:Insert/Updata」を実行すると、以下のようになります。 ```markdown # タイトル ## 目次 <!-- TOC --> - [タイトル](#タイトル) - [目次](#目次) - [概要](#概要) - [節1](#節1) - [節2](#節2) <!-- /TOC --> ## 概要 ### 節1 ### 節2 ``` セクションを入れてみます。「Markdown Sections:Insert/Updata」を実行します。 （表示が更新されない場合は、「Markdown TOC:Insert/Updata」を実行してみてください。） ```markdown # 1. タイトル ## 1.1. 目次 <!-- TOC --> - [1. タイトル](#1-タイトル) - [1.1. 目次](#11-目次) - [1.2. 概要](#12-概要) - [1.2.1. 節1](#121-節1) - [1.2.2. 節2](#122-節2) <!-- /TOC --> ## 1.2. 概要 ### 1.2.1. 節1 ### 1.2.2. 節2 ``` 後は、設定を追記して所望の目次にします。 例えば、タイトルを目次にしたくない場合は、「depthFrom:2 depthTo:6」を追記します。 ```markdown <!-- TOC --> ↓ <!-- TOC depthFrom:2 depthTo:6 --> ``` ```markdown # タイトル ## 1. 目次 <!-- TOC depthFrom:2 depthTo:6 --> - [1. 目次](#1-目次) - [2. 概要](#2-概要) - [2.1. 節1](#21-節1) - [2.2. 節2](#22-節2) <!-- /TOC --> ## 2. 概要 ### 2.1. 節1 ### 2.2. 節2 ``` ## 自動更新について Visual Studio Codeのバージョンによって、自動更新の振舞いが異なるような気がします。 自動更新が嫌な場合は、「updateOnSave:false」を追記します。 ただし、「Markdown Sections:Delete」や「Markdown Sections:Insert/Updata」を実行して、すぐに更新されない場合は、「Markdown TOC:Insert/Updata」を実行してみてください。 ## アンカーについて これらの文書はGitHubなどのサーバにアップロードすればHTMLとして見ることができます。 「insertAnchor:true」（アンカーの挿入）を追記しても目次のリンクがうまくいかない場合があります。 そんな時は、以下のように「markdown-」を削除してみてください。 ``` <a id="markdown-12-概要" name="12-概要"></a> ↓ <a id="12-概要" name="12-概要"></a> ``` うまくリンクするかもしれません。 ## ひとこと 簡易な文書ならMarkdownで書くのが、ますます良い気がしてきました。でも、仕事で流行らせるのは難しそうです。Office信仰は根強いです。