markdownlintをつかって、Markdownファイルの構文チェックを行う

ひとつ前の記事で、textlintというツールを紹介しました。

今回は、Markdownの構文をチェックする、Markdownlintを紹介します。

Markdownlint

Markdownlintとは、Markdownの構文をチェックするツール。

インストールは次のようにする。

yarn add markdownlint-cli

ルールを除外するには、設定ファイル.markdonlintrc.jsonに書き込む。

{
  "MD002": false,
  "MD034": false
}

次のようにして使う。

./node_modules/markdownlint-cli/markdownlint.js -c .markdownlintrc.json filename.md

例によって、vscodeのプラグインがある。