この記事よりもっといい記事があります。
現在では脚注の書き方について公式からもっと詳しい記事が公開されていますので、そちらを読むことをお勧めします。1
概要
- 完全に自分用記事です QiitaというよりMarkdownの仕様のはなしかも。
- Qiitaの記事に脚注を入れるとき、
[^1]
のように数字じゃなくても[^foot-note]
のような文字列で指定できた。 - 他の記事でも出てるんですが
脚注に対する勘違いと混乱
もう概要で書いちゃいましたね。
Qiitaで使うMarkdownにおいて、脚注を入れる際にこんなサンプルがよく見られます。
脚注を入れたい
脚注についてのサンプルです。[^1]
記事中に余談を書くのは邪魔だから脚注で補足入れたい。時ありますよね。[^2]
[^1]: サンプルなので適当な文です
[^2]: 脚注が多い文章も困りものですが
しかし、この\[^1]
と\[^1]:
のような連番による注釈は記事をアップデートする際の管理が大変です。間に文章を差し込んだときにそこに入れる脚注の番号はどうすればいいでしょうか?こんな風にだんだん混乱して来ます。
文を追加したいけど脚注どうしよう
脚注についてのサンプルです。[^1]
あとから文を差し込みたい時もありますよね。[^3]
記事中に余談を書くのは邪魔だから脚注で補足入れたい。時ありますよね。[^2]
[^1]: サンプルなので適当な文です
[^2]: 脚注が多い文章も困りものですが
[^3]: 差し込んだ脚注です
上のように書いても表示上は数字に関係なく出現順に1、2、3の連番で並びます。 見た目は不自然なく見えるんですが、管理はつらい。3
しかしこの脚注、実はこんな風に書けます。
脚注に名前を付けて管理する
脚注についてのサンプルです。[^sample]
あとから文を差し込みたい時もありますよね。[^sashikomi]
記事中に余談を書くのは邪魔だから脚注を入れたい。時ありますよね。[^arimasu]
[^sample]: サンプルなので適当な文です
[^sashikomi]: 差し込んだ脚注です
[^arimasu]: 脚注が多い文章も困りものですが
このほうが解りやすくなりますね。この方法で積極的に使っていきたいです。
この記事でも使っているので、この記事のMarkdownも参考にしてもらえればと思います。
それでも忘れちゃいけない大事なこと
あまり長い記事を書かない。
いわゆるTL;DRですが、読まれないだけじゃなくて記事をメンテしていくのも大変です。