calendar

Markdownの構文チェックツール「markdownlint」

category VS Code
tag VS Code tag 拡張機能 tag Markdown tag Linter
toc目次

markdownlintとは

markdownlintはMarkdownの構文とスタイルをチェックするVS Codeの拡張機能です。

markdownlint
Markdown linting and style checking for Visual Studio Code
marketplace.visualstudio.com marketplace.visualstudio.com

markdownlintの導入方法

VS Codeの拡張機能ウインドウで「markdownlint」を検索し、「install」を選択すると導入できます。
markdownlint

markdownlintの使用方法

markdownlintがインストールされたVS CodeでMarkdownファイルを編集する際、ルールに違反する行があると、エディターで警告が表示されます。
markdownlint

問題パネルにも指摘内容が表示されます。
markdownlint

指摘事項の修正は、エラーの行を選択しクイックフィックスより自動で修正できます。
markdownlint

VS Codeの設定（setting.json）に以下を記述すると、ファイル保存時に自動で指摘事項が修正されるようになります。

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

markdownlintのルールについて

markdownlintで指摘されるルールは以下に一覧があります。

一部のルールのチェックを無効にしたい場合は、markdownlintの設定で「ルールのID: false」とすることで無効にできます。

「MD033(Inline HTML)」のチェックを無効にしたい場合は、setting.jsonに以下を記述します。

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