link-test.md

GithubのMDファイル内・ファイル間のリンクアンカーに関する注意点まとめ

実際のコードは[Raw]ボタンをクリックしてマークダウンをご参照ください

MDファイルから目次(Table of Contents)を自動的に生成してくれるこちらのブラウザアプリもどうぞ

• ❌ アルファベットは表示通りに打ち込んでもダメ
• ⭕ アルファベットはすべて小文字にしないといけない
• ⭕ スペースを含む場合はさらにハイフンで区切らないとダメ
• ⭕ ハイフンはそのままで良い つまり header 1 と header-1 のアンカーは区別できない
• ⭕ 日本語は勝手にURLエンコードしてくれるのでそのままで打ち込んでOK
• ❌ 逆にURLエンコードしてしまうと二重にエンコードされてダメ
• ⭕ 英語と日本語の組み合わせの場合アルファベットだけは小文字にすることを忘れない
• ⭕ #や"などはそのまま消すだけでOK つまり #"header" と header のアンカーは区別できない
• ⭕ 基本的にアンダースコアとハイフン以外の半角記号はすべて消されると思って良いようです

AlphabeticHeader1

AlphabeticHeader2

Header With Space

Header-With-Hyphen

日本語のヘッダ 1

日本語のヘッダ 2

日本語とAlphabetのヘッダ

ヘッダーに#や"を含む

RCF2396のFragment Identifier(#...)では次のように定義されていて、#記号もエスケープすれば使えるはずだけど、Githubでは本来使えるはずのreservedや"markの記号やその他半角記号(")などもまとめて消しちゃうようです

the optional fragment identifier, separated from the URI by a crosshatch ("#") character
fragment = *uric
uric = reserved | unreserved | escaped
reserved = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" | "$" | "," 
unreserved = alphanum | mark
mark = "-" | "_" | "." | "!" | "~" | "*" | "'" | "(" | ")"
escaped     = "%" hex hex
hex = digit | "A" | "B" | "C" | "D" | "E" | "F" | "a" | "b" | "c" | "d" | "e" | "f"
http://www.ietf.org/rfc/rfc2396.txt

そういうわけで、

;/?:@&=+$,-_.!~*'()"quot"

は、 #-_quot になります。例外的にアンダースコアとハイフンは消されません