MDUtil

Markdown 目次ジェネレーター

README や Markdown の文書を貼り付けると、GitHub、GitLab、VS Code でクリックして移動できる目次ができます。内容はアップロードされません。

Markdown

153 文字25 行
- [はじめに](#はじめに)
  - [インストール](#インストール)
  - [初回の起動](#初回の起動)
- [設定](#設定)
  - [同期と保存](#同期と保存)
  - [写真](#写真)
- [よくある質問](#よくある質問)
- [使い方](#使い方)
- [使い方](#使い方-1)

対応している内容

GitHub のアンカー
リンクは GitHub と同じアンカーを使います。英字は小文字に、空白はハイフンに、記号は除かれ、同じ見出しには -1、-2 が付きます。
レベルの範囲を自由に
## と ### だけなど、1〜6 の任意の範囲を選べます。入れ子は見出しのレベルに合わせます。
その場で更新
ファイルに <!-- toc --> と <!-- tocstop --> を置くと、毎回その間に目次が書き込まれます。
コードは無視
コードブロック内の # で始まる行は見出しとして扱いません。
すっきりしたリンク
見出し内の太字、コード、リンクは目次ではただの文字になります。
日本語と中国語の見出し
GitHub と同じく、日本語や中国語の見出しはアンカーでも元の文字のままです。

GitHub の見出しアンカーの作られ方

GitHub は見出しの文字から各見出しのアンカーを作ります。英字は小文字になり、空白はハイフンになり、記号は取り除かれます。同じ見出しが続くと -1、-2 が付きます。

見出しリンク
## Getting Started#getting-started
## 同期 & 保存#同期--保存
## インストール#インストール
2 つ目の ## 使い方#使い方-1

見出しへはアンカーでリンクします。例：[インストール](#インストール)。GitLab と VS Code も同じ方法でアンカーを作ります。

よくある質問

Markdown ファイルに目次を付けるには？

上にファイルを貼り付けて目次をコピーし、ファイルに入れます。または入れたい位置に <!-- toc --> と <!-- tocstop --> を置き、2 つ目のタブから文書全体をコピーします。

GitHub は目次を自動で作りますか？

GitHub はファイルの上のアウトラインボタンから README の見出しの一覧を表示しますが、ファイルに目次を書き込むことはしません。ファイルに書いたリンクの一覧は、ほかのサイトやエディタ、書き出した文書でも使えます。

Markdown で見出しにリンクするには？

見出しのアンカーを使います。例：[インストール](#インストール)。アンカーは見出しの文字を小文字にし、空白をハイフンにして記号を除いたものです。

目次を最新に保つには？

ファイルに <!-- toc --> マーカーを残しておき、編集後にもう一度ここへ貼り付けると、マーカー間の目次が置き換わります。VS Code では Markdown All in One 拡張機能で保存時に更新できます。

リンクを押しても見出しに移動しないのはなぜ？

サイトによってアンカーの作り方が違うためです。ここでのリンクは GitHub、GitLab、VS Code の規則に従います。Bitbucket は先頭に markdown-header- を付け、独自の規則を使うサイトジェネレーターもあります。

文書はアップロードされますか？

されません。目次はブラウザ内で作られ、文書が端末の外に出ることはありません。