MDUtil

Markdownの脚注

注を付けたい位置に [^1] を書き、下のどこかに [^1]: 注の文。 を書きます。ラベル、長い注、同じ注の再参照、脚注に対応するアプリを説明します。

要点

Markdownで脚注を付けるには？

語句のあとに角括弧、キャレット、ラベルを [^1] のように書き、同じラベルとコロンで注を1行で定義します：[^1]: 注の文。 注は番号順に文書の最後へまとめられ、本文へ戻るリンクが付きます。

Markdown
Markdownは2004年に生まれました。[^1]

[^1]: John Gruberが公開し、Aaron Swartzが設計に協力しました。

表示結果

Markdownは2004年に生まれました。1

Footnotes

  1. John Gruberが公開し、Aaron Swartzが設計に協力しました。 ↩

脚注の書き方と例

脚注はGitHub Flavored MarkdownとPandocの記法です。参照と定義は同じラベルを使えば対応します。

名前付きの脚注

ラベルには単語も使えます。表示される注は、最初に参照された順に番号が振られます。

Markdown
仕様はあらゆる例外を扱っています。[^spec]

[^spec]: CommonMarkの仕様を参照。

表示結果

仕様はあらゆる例外を扱っています。1

Footnotes

  1. CommonMarkの仕様を参照。 ↩

複数段落の注

注の2段落目以降は空白4つで字下げします。

Markdown
注を参照。[^long]

[^long]: 注の1段落目。

    2段落目は空白4つで字下げします。

表示結果

注を参照。1

Footnotes

  1. 注の1段落目。

    2段落目は空白4つで字下げします。 ↩

同じ注を何度も参照する

同じラベルを使うと同じ注を指します。注には参照ごとに戻るリンクが付きます。

Markdown
1回目の言及。[^src]2回目の言及。[^src]

[^src]: どちらの参照もここを指します。

表示結果

1回目の言及。12回目の言及。1

Footnotes

  1. どちらの参照もここを指します。 ↩ ↩2

定義を書く場所

定義はどこに書いてもよく、段落の直後にも書けます。注は常に文書の最後に表示されます。

Markdown
最初の段落。[^a]

[^a]: 段落の直後で定義しています。

この段落も注より前に表示されます。

表示結果

最初の段落。1

この段落も注より前に表示されます。

Footnotes

  1. 段落の直後で定義しています。 ↩

注の中の書式

注には普通の段落と同じく、リンク、コード、強調を使えます。

Markdown
npmでインストールします。[^npm]

[^npm]: `npm install` を実行するか、[npmのドキュメント](https://docs.npmjs.com)を参照してください。

表示結果

npmでインストールします。1

Footnotes

  1. npm install を実行するか、npmのドキュメントを参照してください。 ↩

インライン脚注

PandocとObsidianでは、注の文を文中に直接書けます。ほかのレンダラーではそのまま表示されます。

Markdown
水は100 °Cで沸騰します。^[海面の気圧の場合。]

PandocとObsidianだけの書き方です。ほかのMarkdownアプリでは表示が異なるため、プレビューはありません。

各サービスでの対応状況

脚注は拡張記法なので、対応は広いもののすべてではありません。

サービス対応補足
GitHub対応ファイル、Issue、PR、コメントで使え、戻るリンクも付きます。
GitLab対応ファイル、Issue、マージリクエストで使えます。
Obsidian対応脚注と、^[文字] と書くインライン脚注に対応しています。
Qiita / Zenn対応どちらも脚注に対応しています。
Discord / Slack非対応脚注はなく、角括弧がそのまま表示されます。

よくある質問

GitHubは脚注に対応していますか？

対応しています。ファイル、Issue、プルリクエスト、コメントで使え、注は最後にまとめて表示され、各参照へ戻るリンクが付きます。

脚注が表示されないのはなぜですか？

参照の [^1] と定義の [^1]: 文 の両方が同じラベルでそろっていないと表示されません。定義は行頭に書き、角括弧の直後にコロンを置きます。

脚注の表示位置を指定できますか？

できません。レンダラーはすべての注を文書の最後に集め、最初に参照された順に並べます。

脚注のラベルは数字でなければなりませんか？

数字でなくてもかまいません。[^source] のように空白を含まないラベルなら使え、表示はやはり番号になります。

脚注にリンク、コード、リストを入れられますか？

入れられます。インラインの書式はそのまま使え、空白4つで字下げした行で段落、リスト、コードブロックを追加できます。

脚注は標準のMarkdownですか？

CommonMarkには脚注がありません。GitHub Flavored Markdown、Pandoc、Obsidian、多くのサイトジェネレーターが拡張として追加しています。

インライン脚注はどう書きますか？

PandocとObsidianでは文中に ^[注の文] と書けます。GitHubは対応していません。

WordやPDFに書き出しても脚注は残りますか？

Markdown Word 変換ではWordのページ下部の脚注になり、Markdown PDF 変換では文書の最後に印刷されます。