マークダウンの文法をチェックする方法 (markdownlint)

markdownlint

リポジトリ：

DavidAnson/markdownlint: A Node.js Style Checker and Lint Tool for Markdown / Common Mark Files – GitHub

使い方

参考：

Markdown ファイルを構文チェックする仕組み – Qiita

Markdown を Lint チェックできる markdownlint を試してみた | Neo’s World

コミット時に Markdown ファイルの構文が正しいか npm test でチェックさせる | Steel Dragon 14106

設定

ドキュメント：

Configuration – DavidAnson/markdownlint – GitHub

ルール

ドキュメント：

Rules – DavidAnson/markdownlint – GitHub

行末の空白

行末の空白を許可しない。(<br> タグ代わりの空白2個を許可しない。)

{
    "MD009": { "br_spaces": 0 }
}Code language: JSON / JSON with Comments (json)

ドキュメント：

MD009 Trailing Spaces – DavidAnson/markdownlint – GitHub

カスタムルール

ドキュメント：

Custom Rules – DavidAnson/markdownlint – GitHub

自動修正 (Fix)

参考：

question: user-defined fix rules · Issue #381 · DavidAnson/markdownlint-cli2 – GitHub

AI 生成

参考：

AI が生成するマークダウンがやたら markdownlint で引っかかる現象の緩和策 | サーバーワークスエンジニアブログ

CLI (Igor Shubovych)

リポジトリ：

igorshubovych/markdownlint-cli: MarkdownLint Command Line Interface – GitHub

CLI2 (David Anson)

※ CLI2 専用の設定ファイルが存在するので注意する。(より高度な利用方法が可能となる。)

リポジトリ：

DavidAnson/markdownlint-cli2: A Fast, Flexible, Configuration-Based Command-Line Interface for Linting Markdown / Common Mark Files with the markdownlint Library – GitHub

ドキュメント：

Configuration – DavidAnson/markdownlint-cli2 – GitHub

VSCode Extension

Markdown Linting and Style Checking for Visual Studio Code

設定

• markdownlint.config： 設定ファイル (.vscode/settings.json) に追加する
• .markdown.json / .markdown.yaml： 各フォルダ毎に配置する設定ファイル
• markdownlint.configFile： 指定したパスの設定ファイルを使用する

入手：

markdownlint | Visual Studio Marketplace [Official]

リポジトリ：

DavidAnson/vscode-markdownlint – GitHub

参考：

markdownlint の使い方 – Qiita

設定詳解 – Qiita

Reason for deprecating markdownlint.config? · Issue #456 · DavidAnson/vscode-markdownlint – GitHub

MDL (Ruby Gem)

リポジトリ：

markdownlint/markdownlint: Markdown Lint Tool – GitHub

入手：

mdl | RubyGems.org

Search Replace (Onkar Ruikar)

リポジトリ：

OnkarRuikar/markdownlint-rule-search-replace: A Custom Markdown Lint Rule to Replace Strings / Patterns – GitHub

入手：

markdownlint-rule-search-replace – npm