マニュアル: Markdown

投稿日: 更新日:
markup

主なMarkdownの書式

見出し

  • #→<h1>, ##→<h2>, …
  • 見出しにIDを付ける場合は ### 見出し {#midashi} などとする。

リンク

  • 通常のリンク: [リンクテキスト](URL)
  • 名前付きリンク:
    • リンク: [リンクテキスト][名前]
      • リンクテキスト = 名前の場合は[リンクテキスト][]のように省略可能
      • GitHub Flavored Markdownの場合は[リンクテキスト]のみでOK1
    • 名前の定義: [名前]: URL

脚注

  • リンク: [^n]: nは1から始まる数字2
  • 脚注の定義: [^n]: 説明

Lint

VS Codeのプラグイン。

設定はファイル .markdownlint.json に記載する。 例えChangeLogで同じ名前の見出しをつけている場合、MD024(同じ名前の見出しをつけない)が警告される。

これを抑制するためには、以下のようにする。

{
  "MD024": {
    "siblings_only": true
  }
}

  1. GitHub Flavored Markdown Spec Example 527 ↩︎

  2. Hugoでは[^footnote]のような書き方もできますが、この規則がどこから来ているのかは分かりません。。。 ↩︎

逆引きマニュアル