Markdown Linter

チェック内容

markdownlintの全ルールを適用します。主な内容：

• MD001 — 見出しレベルは一度に1段階だけ増やす
• MD009 — 行末にスペースを置かない
• MD010 — ハードタブを使わない（スペースを使用）
• MD012 — 連続する空行を複数置かない
• MD022 — 見出しの前後には空行を入れる
• MD025 — ドキュメント内のH1は1つだけ
• MD031 — コードフェンスの前後には空行を入れる
• MD034 — 裸のURLは使わず、リンク記法を使う
• MD041 — 最初の行はトップレベルの見出し

プライバシー

処理はすべてクライアント側で行われます。Markdownはアップロードも保存もされません。

関連ツール

• Markdown プレビュー — MarkdownをHTMLとしてリアルタイムレンダリング
• Markdown 表作成ツール — 視覚的にテーブルを作成

例：CHANGELOG

入力：

# Changelog

## 1.2.0

### Added

- Export button

## 1.1.0

### Added

* Dark mode

See https://example.com/releases

結果（markdownlint 0.40、既定のルール）：

L13  MD004 / ul-style            Unordered list style — Expected: dash; Actual: asterisk
L11  MD024 / no-duplicate-heading Multiple headings with the same content
L15  MD034 / no-bare-urls         Bare URL used

• どちらのバージョンにも「Added」見出しがあるため MD024 が出ます。Keep a Changelog の標準的な書き方なので、自分の設定では "MD024": { "siblings_only": true } として親が異なる同名見出しを許可します。
• MD004 は文書内でリスト記号を 1 種類にそろえるよう求めます。最初のリストが - なので * が指摘されます。
• MD034 は裸の URL を <https://example.com/releases> か Markdown のリンクにするよう求めます。

ここでは変えられない既定値

ツールは markdownlint が既定で有効にしているルールをすべて、既定の設定で実行します（markdownlint rules を参照）。設定画面はないため、次の 2 つがよく余計な指摘になります：

• MD013 行の長さは 80 文字です。104 文字の英文の行は Expected: 80; Actual: 104 と報告されます。80 桁目以降に空白のない長い行は報告されないので、空白を含まない日本語の長い行はたいてい通ります。
• MD024 は文書内で同じ見出しの文字列が繰り返されると指摘します。上の CHANGELOG がその例です。

自分の設定で検査するなら .markdownlint.json に書き、ローカルや CI で markdownlint-cli2 を実行します：

{
"MD013": { "line_length": 120 },
"MD024": { "siblings_only": true }
}

markdownlint はファイル先頭の YAML Front Matter を読み飛ばし、その中の title は MD041 ではトップレベルの見出しとして扱われます。