脚注
脚注は、Markdownの拡張機能で、文書に参照メモや補足情報を追加し、読者が読書の流れを中断することなく追加の説明を表示できるようにします。
基本的な構文
脚注の追加
Markdownでの脚注作成は、脚注マーカーと脚注内容の2つの部分で構成されます。
これは脚注を含む段落です[^1]。
[^1]: これは脚注の内容です。
レンダリング効果:
これは脚注を含む段落です^1。
複数の脚注
Markdownは、John Gruber[^2]によって作成された軽量マークアップ言語[^1]で、現在、文章作成で広く使用されています[^3]。
[^1]: Markdownは、シンプルな構文でテキスト書式を実現します。
[^2]: John Gruberは2004年にMarkdownを作成しました。
[^3]: GitHub、Stack Overflow、ブログプラットフォームなど、多くのプラットフォームがMarkdownをサポートしています。
レンダリング効果:
Markdownは、John Gruber[^2]によって作成された軽量マークアップ言語^1で、現在、文章作成で広く使用されています[^3]。
[^2]: John Gruberは2004年にMarkdownを作成しました。 [^3]: GitHub、Stack Overflow、ブログプラットフォームなど、多くのプラットフォームがMarkdownをサポートしています。
高度な使用法
脚注識別子
脚注識別子は数字または単語にできますが、スペースやタブを含めることはできません。
これは通常の脚注[^1]と、識別子を持つ脚注[^note]です。
[^1]: これは通常の脚注です。
[^note]: これは識別子を持つ脚注です。
レンダリング効果:
複数段落の脚注
脚注の内容は、複数の段落や他の要素を含むことができ、適切なインデントが必要です。
これは複数の段落を含む脚注です[^multipara]。
[^multipara]: これは脚注の最初の段落です。
これは脚注の2番目の段落です。少なくとも4つのスペースまたは1つのタブでインデントします。
> 脚注にブロッククォートを含めることもできます。
- リストも含めることができます
- 順序付きと順序なしの両方のリストがサポートされています
レンダリング効果:
これは複数の段落を含む脚注です^multipara。
これは脚注の2番目の段落です。少なくとも4つのスペースまたは1つのタブでインデントします。
> 脚注にブロッククォートを含めることもできます。
- リストも含めることができます
- 順序付きと順序なしの両方のリストがサポートされています
インライン脚注
一部のMarkdown実装はインライン脚注構文をサポートしていますが、これは標準のMarkdownの一部ではありません。
これはインライン脚注^[文書の最後ではなく、テキスト内に直接脚注の内容を追加します]です。
レンダリング効果(サポートされているプラットフォーム):
これはインライン脚注^[文書の最後ではなく、テキスト内に直接脚注の内容を追加します]です。
互換性と実装の違い
さまざまなプラットフォームでのサポート状況
プラットフォーム/ツール | 標準脚注 | インライン脚注 | 複数段落の脚注 |
---|---|---|---|
GitHub Markdown | ✅ | ❌ | ✅ |
GitLab Markdown | ✅ | ✅ | ✅ |
Jekyll (kramdown) | ✅ | ✅ | ✅ |
Hugo | ✅ | ✅ | ✅ |
CommonMark | ❌ | ❌ | ❌ |
VitePress | ✅ | ✅ | ✅ |
Pandoc | ✅ | ✅ | ✅ |
HTML出力形式
ほとんどのMarkdownプロセッサは、脚注をリンクと戻り矢印付きのHTMLに変換します:
<!-- 脚注参照 -->
<p>これは脚注を含む段落<sup id="fnref:1"><a href="#fn:1" class="footnote-ref">1</a></sup>です。</p>
<!-- 脚注内容(通常は文書の最後) -->
<div class="footnotes">
<hr>
<ol>
<li id="fn:1">
<p>これは脚注の内容です。<a href="#fnref:1" class="footnote-backref">↩</a></p>
</li>
</ol>
</div>
使用推奨事項とベストプラクティス
脚注を使用するタイミング
以下の状況で脚注が適しています:
- 出典の引用: 研究論文、書籍、その他の参考文献の引用
- 補足説明: メインコンテンツを中断せずに追加情報を提供
- さらなる読書: 興味のある読者に追加のリソースを提供
- 用語説明: 技術用語や略語の説明
脚注の文字組版に関する提案
✅ 推奨プラクティス:
1. **脚注内容を最後に配置**: すべての脚注定義を文書の最後に置き、メンテナンスを容易にする
2. **一貫性を保つ**: 脚注マーキング方法(数字または意味のある識別子)を一貫して使用
3. **適度に使用**: 多すぎる脚注は読者の注意を散漫にする
4. **意味のある内容を提供**: 脚注はメインテキストを繰り返すのではなく、実際の価値を追加する
❌ 避けるべき慣行:
1. 1つの文に複数の脚注を使用
2. 脚注にコア情報を表示
3. 脚注に過度に長いコンテンツを配置
4. 脚注内に脚注をネスト
長文書での脚注
非常に長い文書の場合、章ごとに脚注をグループ化できます:
# 第1章
これは第1章のコンテンツで、脚注を含みます[^1-1]。
[^1-1]: 第1章の最初の脚注。
# 第2章
これは第2章のコンテンツで、別の脚注を含みます[^2-1]。
[^2-1]: 第2章の最初の脚注。
一般的な問題の解決
脚注が表示されない
脚注が正しく表示されない場合:
- 脚注識別子と脚注定義が完全に一致することを確認(大文字小文字を含む)
- 脚注定義が正しい形式であることを確認(コロンの後にスペースが必要)
- Markdownプロセッサが脚注構文をサポートしているかを確認
- 脚注定義の前後に空白行を残してみる
脚注番号の混乱
一部のプロセッサは、カスタム識別子を使用しても脚注を自動的に再番号します。これは予期される動作で、最終的な表示は通常連続した番号になります。
モバイルデバイスでの使用性
モバイルデバイスでは、脚注リンクが小さく、クリックしにくい場合があります。脚注のホバープレビューをサポートするリーダーを使用することで、この問題を改善できます。
関連構文
- リンク - 基本的なリンク構文
- 取り消し線 - その他のテキスト書式オプション
- 囲み付きコードブロック - コードブロック構文
演習と応用
- 少なくとも3つの異なる脚注を含む短い記事を作成
- 複数段落の内容を持つ脚注を作成
- 学術または技術記事で参考文献を引用するために脚注を使用
脚注は、Markdownドキュメントの専門性と信頼性を高める重要なツールです。メインコンテンツの流れを中断せずに追加情報を提供でき、文書をより完全で信頼性の高いものにします。