Markdown Linter

Markdownのスタイルとフォーマットエラーをリアルタイムで検出。ルールID・行番号付きの結果をクリックで該当行にジャンプ。ブラウザー内で処理し、Markdown はサーバーに送信しません。

  • ブラウザ内で処理
  • ツールの入力を ZeroTool のサーバーにアップロードしません
  • 無料 · 登録不要
「クリア」、またはツール内にフォーカスがある状態の Ctrl/⌘+L で、入力・結果・概要を消去します。待機中のチェックを取り消し、以前の結果やコピー表示が戻ることを防ぎます。
「結果をコピー」は表示中の問題ごとに、行番号、角括弧内のルール ID、説明、詳細、文脈を 1 行のテキストとしてコピーします。ルールの別名は含めません。問題がない場合はコピーしません。
Markdown 文書を 1 件編集します。入力の 300 ミリ秒後に markdownlint の既定ルールで検査し、最初のサンプルには意図的な問題があります。文書内の markdownlint-disable・markdownlint-enable コメントでルールを停止できます。設定ファイルのアップロードや自動修正はありません。
Lint 結果 各問題にルール ID・行番号・説明と、存在する詳細・文脈・別名を表示します。問題をクリックするとエディタで対象行を選択します。説明と詳細は markdownlint の英語です。検査は問題を報告し、文書は変更しません。
入力すると結果が表示されます。
例・詳しい説明・よくある質問 実際の出力つきの例、ほかのツールとの違い、よくある質問。

チェック内容

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

  • MD001 — 見出しレベルは一度に1段階だけ増やす
  • MD009 — 行末にスペースを置かない
  • MD012 — 連続する空行を複数置かない
  • MD018 — ATX 見出しの # の後に空白を入れる
  • MD022 — 見出しの前後には空行を入れる
  • MD026 — 見出しの末尾に句読点を付けない
  • MD034 — 裸のURLは使わず、リンク記法を使う
  • MD041 — 最初の行はトップレベルの見出し

# の後の全角スペースと末尾の記号

# の後ろに全角スペースが入った見出しと、末尾に「!」や「?」を付けた見出しを例にします。次の文書で「結果をコピー」を押すと 3 行になります。

# インストール

## よくある質問?

## 注意!

`npm install` を実行します。
行 1 [MD018] No space after hash on atx style heading [# インストール]
行 5 [MD026] Trailing punctuation in heading — Punctuation: '!'
行 1 [MD041] First line in a file should be a top-level heading [# インストール]
  • CommonMark の ATX 見出しは # の後に半角スペースかタブ(または行末)が必要です。全角スペース(U+3000)では見出しにならず普通の段落になるため、1 行目は MD018 と MD041 の両方に該当します。
  • MD026 の既定の対象は .,;:!。,;:! で、全角の「!」は入っていますが、疑問符は FAQ 形式の見出しでよく使うため除かれています(MD026 のドキュメント)。そのため「よくある質問?」は指摘されません。
  • 結果はルール番号順、同じルールの中では行番号順に並びます。

指摘されないが表示が崩れる書き方

markdownlint は書き方を検査するもので、文書を描画しません。次の文書は「問題なし」になりますが、表示は期待どおりになりません。

# 記事の書き方

**「重要」**です。

日本語の文章は単語のあいだに空白を入れないため、一つの段落を一行で書くとこの行のように八十文字を大きく超えますが、MD013は八十桁目より後ろに空白のない行を報告しないので、この行は問題として表示されません。
問題なし
  • 3 行目の太字は効きません。閉じる ** の前が「」」、後ろが「で」なので、CommonMark 0.31.2 の 6.2 節の規則では強調を閉じられず、アスタリスクがそのまま表示されます。
  • 5 行目は 104 文字ありますが、MD013 は 80 桁目より後ろに空白がない行を対象外にするため指摘されません(MD013 のドキュメント)。英文の行なら同じ長さで Expected: 80; Actual: 104 が出ます。

太字が効かない場面と回避方法はマークダウン記法 一覧にまとめています。描画結果は Markdown プレビューで確かめられます。

例:CHANGELOG

入力:

# Changelog

## 1.2.0

### Added

- Export button

## 1.1.0

### Added

* Dark mode

See https://example.com/releases

「結果をコピー」の内容(markdownlint 0.40、既定のルール、末尾に改行あり。末尾の改行がないと MD047 も出ます):

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

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

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

  • MD013 行の長さは 80 文字です。上で見たとおり、80 桁目以降に空白のない日本語の長い行はたいてい通ります。80 桁目より後ろに半角・全角を問わずスペースがある行(英単語をスペースで区切って混ぜた行など)は対象になります。
  • MD024 は文書内で同じ見出しの文字列が繰り返されると指摘します。上の CHANGELOG がその例です。

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

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

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

制限事項

  • ルールの説明と詳細は markdownlint のもので、どの言語版でも英語です。
  • 問題を報告するだけで、自動修正はしません。markdownlint-cli2 の --fix で多くは自動修正できます。
  • 一度に検査するのは 1 文書で、設定は既定値のままです。.markdownlint.json のアップロードはできません。文書内の <!-- markdownlint-disable MD013 -->、<!-- markdownlint-enable MD013 -->、<!-- markdownlint-disable-next-line MD034 --> コメントで一部だけルールを止められます。
  • スペル、文書外のリンク切れ、GitHub などのレンダラーでの実際の見え方は確認しません。

プライバシー

markdownlint はこのページの中で動きます。Markdown はアップロードされず、ブラウザーのストレージにも保存しません。ページを再読み込みすると、エディタはサンプル文書に戻ります。アクセス解析が記録するのは「結果をコピー」でコピーできたことだけで、コピーに失敗したときは記録しません。

関連ツール

FAQ

コンテンツはサーバーに送信されますか?

いいえ。markdownlint はこのページに組み込まれていて、ブラウザー内で Markdown を検査します。内容はサーバーに送られず、ツールがブラウザーのストレージに保存することもありません。ページは Google Analytics を読み込み、「結果をコピー」でコピーできたときにツール名と「copy_results」という動作を記録します。Markdown や検査結果は含まず、コピーに失敗したときやコピーする問題がないときは記録しません。

どのルールをチェックしますか?

markdownlint 0.40 の全 53 ルールを既定の設定で実行します。見出しレベル、行末スペース、空行の数、裸の URL、リストの記号、コードフェンスなどが対象です。MD043(必須の見出し構成)や MD044(固有名詞の表記)のように設定してはじめて働くルールは、このページには設定欄がないため何も報告しません。

MD001などのルールIDは何を意味しますか?

ルール ID は markdownlint の番号です。MD001 の別名は heading-increment(見出しレベルは 1 段ずつ上げる)、MD009 は no-trailing-spaces(行末スペース)、MD041 は first-line-heading(最初の行は H1)です。各ルールの説明は markdownlint リポジトリのルール文書にあります。

結果をクリックしてその行にジャンプできますか?

はい。「Lint 結果」の項目をクリックすると、エディタが対象の行にスクロールして選択されます。

CLIのmarkdownlintと何が違いますか?

CLI ツールはビルドパイプラインに組み込んでディスク上のファイルを検査し、設定ファイルも読み込めます。このブラウザーツールは、インストールせずに Markdown を手早く確認したいときに向いています。

全角スペースは指摘されますか?

場所によって違います。「# 見出し」のように # の後ろが全角スペースだと、見出しにならず MD018(# の後に空白がない)が出ます。行頭の全角スペースで字下げしたリスト項目は、ルールに引っかからず「問題なし」になりますが、サブリストにはならず前の項目の続きの文字として表示されます。