Markdownlintとは

Markdownlintを使用することでMarkdownの構文とスタイルをチェックできます。

インストール

Markdownlintをインストールします。

ルールに違反している箇所は以下の画像のように指摘されます。

指摘されている箇所にカーソルを合わせることで指摘事項を確認できます。

画面に表示された青い電球マークをクリックすることでクイックフィックスを利用できます。

ルールの設定を自分で行うことができます。
設定には以下の方法があります。

setting.jsonに記述する場合には以下のようにします。

まずcmd + shif + pでコマンドパレットを開きます。
Preferences: Open User Settings (JSON)を実行しsetting.jsonを開きます。
setting.jsonに以下を追記します。

setting.json

  "markdownlint.config": {
    "MD033": false
  }

ルールの種類については以下のページをご参照ください。

setting.jsonに以下のように記述することでファイル保存時に指摘事項を修正できます。

setting.json

  "[markdown]": {
    "editor.codeActionsOnSave": {
      "source.fixAll.markdownlint": true
    }
  }