GitHub の discussions で使える HTML の便利記法

バックエンドエンジニアの大和道子です。
GitHub で開発をしていると、discussions を活用して情報を共有することがありますが、HTML の記法を使用することで、読みやすく柔軟な書き方が可能になります。
ぜひ使ってみてください！

ページ内リンク

ページ内リンクが紐づけられないなーというのではまったので備忘録
discussions が長くなる時は文書を分けるか、目次を作ってあげると優しいです。

書き方

ここに飛びたい！

• リンク

  • 書き方
    [表示させたい文字列](#段落リンク)

  • 例
    [ここに飛びたい！](#ここに飛びたい)

• 飛びたい先の段落

  • 書き方
    ## 段落名[半角スペース]<a href="段落リンク" id="段落リンク"/>

  • 例
    ## ここに飛びたい！ <a href="ここに飛びたい" id="ここに飛びたい"/>

段落リンクの注意点

• 段落の深さに関係なく、# は1個
• 全角記号は抜く
• 半角スペースは-

参考

Qiita Markdownのページ内リンクの罠

ここに飛びたい！

飛べた

折り畳みセクションが作りたい

こんなやつ

内容

たくさん書いて長くなっちゃうときに便利

書き方

<details>
  <summary>トグルの横に表示する文字列</summary>

折りたたまれる箇所

</details>