入力Markdown

リントレポート

Markdownリントの例

リンターはスタイルの問題を検出します:長い行、見出しの飛び、混在したリストマーカー。例:

一般的な問題のあるMarkdown

長い行、見出しの飛び(H2からH3へH1をスキップ)、-*の混在したリストマーカー。

サンプル

上のエディターに貼り付けてリントレポートを確認してください。サンプルでさらに読み込めます。

Markdownリンターとは?

GitHubにドキュメントをプッシュしたのに、レンダリングが崩れていることに気づいたことはありませんか?見出しレベルが飛んでいたり、リストマーカーが混在していたりすると、READMEやWikiが乱れて見えます。Markdownリンターはこれらの問題を事前に発見します。CommonMark仕様やCommonMark仕様書に基づいたルールで、GitHub Flavored Markdown (GFM)の拡張構文にも対応。MDNなどのドキュメントサイトもMarkdownの品質を重視しています。コミット前にリントして、読者に確実に正しく届けましょう。

このツールはブラウザ内で完全に実行されます。Markdownはローカルで解析・分析され、サーバーには何も送信されません。リントレポートは行ごとに重大度(エラー、警告、情報)付きで問題をリストします。MarkdownのフォーマットにはMarkdownフォーマッターを、検証にはMarkdownバリデーターを使用してください。

このツールの使い方

1

貼り付けまたはアップロード

Markdownを左のエディターに貼り付けるか、アップロードをクリックして.md.markdown.txtファイルを読み込みます。サンプルで一般的な問題のあるサンプルデータを読み込みます。

2

リントレポートを確認

右のパネルに行番号と説明付きでリントレポートが表示されます。左のエディターで問題を修正すると、レポートは自動的に更新されます。コピーまたはダウンロードでレポートを保存できます。

3

修正して再リント

各問題に対処して再実行してください。MarkdownをHTMLに変換するにはMarkdownをHTMLにを、見出しから目次を生成するにはMarkdown目次ジェネレーターを使用してください。

Markdownリントが役立つ場面

GitHubにドキュメントをコミットする前やCMSに公開する前に、リントはレンダリングを壊したり読者を混乱させたりする可能性のある問題を検出します。一貫しない見出し階層は目次を信頼できなくします。壊れた参照リンクは404を引き起こします。ここでMarkdownを実行するとレビュー前の品質が向上します。

ドキュメントサイト、READMEファイル、ブログ記事は一貫したMarkdownの恩恵を受けます。HTMLへの変換にはMarkdownをHTMLにを、見出しから目次を生成するにはMarkdown目次ジェネレーターを、構文リファレンスにはMarkdownチートシートを使用してください。

よくある質問

機密コンテンツを貼り付けても安全ですか?

はい。リントはブラウザ内で完全に実行されます。Markdownはサーバーに送信されません。ブラウザのネットワークタブを開いてトラフィックがないことを確認できます。

何をチェックしますか?

見出し階層(H1からH3へのジャンプ)、ブロック周囲の空行の欠落、一貫しないリストマーカー(-と*の混在)、長い行、CommonMark/GFM準拠などをチェックします。

リンターとバリデーターの違いは何ですか?

リンターはスタイルとベストプラクティスに焦点を当てます(例:見出しの一貫性)。バリデーターは構文の正確性を確認します。品質向上のために両方を使用してください。Markdownバリデーターで検証も試してください。

GitHub Flavored Markdownはサポートしていますか?

はい。GitHub Flavored Markdown (GFM)のテーブル、タスクリスト、取り消し線などのルールをチェックします。GFM固有の問題はレポートで確認できます。

問題を自動で修正できますか?

このツールは問題を報告します。修正は手動で行ってください。空白や改行のフォーマットにはMarkdownフォーマッターを使用してください。

関連ツール

Markdown構文はCommonMarkCommonMark仕様を参照。GitHub Flavored Markdownが拡張しています。Markdown Guideでチュートリアルを提供。GitHubW3C HTMLJekyllも参照。