Tbpgr Blog

元エンジニア 人事 tbpgr(てぃーびー) のブログ

GitHubのREADME.mdのページ内リンク設定

概要

GitHubのREADME.mdのページ内リンク設定

内容

GitHubのREADME.mdのページ内リンク設定

GitHubのREADME.mdで見出し(H1,H2等)を作成した場合に、
自動で

<a name="hoge">

が作成される。
hoge = 見出しの文字列
※実際のタグの詳細は端折ってます。

[ラベルへのリンク](#hoge)で見出し「hoge」へのページ内リンクが作成可能。

補足

見出しの文字列から

<a name="xxxx">

への変換ですが、一部の文字は自動的に置換されている模様。
分かってる範囲で以下がある。

英大文字=>英小文字
半角スペース=>半角ハイフン
ドット=>削除
シャープ=>削除
丸括弧=>削除
カンマ=>削除
コロン=>削除

内部リンク設定参考

tbpgr_utilsのREADME.mdで内部リンクを作成しています。

下記ページを開くと確認可能。マークダウンの記述内容を確認したければページ内のRawボタンを押下すること。
https://github.com/tbpgr/tbpgr_utils/blob/master/README.md