Markdownリンター
Markdownのスタイルと構造の問題をリント
入力Markdown
リントレポート
Markdownリントの例
リンターはスタイルの問題を検出します:長い行、見出しの飛び、混在したリストマーカー。例:
一般的な問題のあるMarkdown
長い行、見出しの飛び(H2からH3へH1をスキップ)、-と*の混在したリストマーカー。
上のエディターに貼り付けてリントレポートを確認してください。サンプルでさらに読み込めます。
Markdownリンターとは?
Markdownはドキュメント、README、Webコンテンツ用の軽量マークアップ言語です。リンターはMarkdownのスタイルと構造の問題をチェックします:一貫しない見出しレベル、欠落した空行、壊れたリンク、期待通りにレンダリングされない可能性のあるフォーマット。CommonMark仕様とGitHub Flavored Markdown (GFM)で構文が定義されています。
このツールはブラウザ内で完全に実行されます。Markdownはローカルで解析・分析され、サーバーには何も送信されません。リントレポートは行ごとに重大度(エラー、警告、情報)付きで問題をリストします。MarkdownのフォーマットにはMarkdownフォーマッターを、検証にはMarkdownバリデーターを使用してください。
このツールの使い方
貼り付けまたはアップロード
Markdownを左のエディターに貼り付けるか、アップロードをクリックして.md、.markdown、.txtファイルを読み込みます。サンプルで一般的な問題のあるサンプルデータを読み込みます。
リントレポートを確認
右のパネルに行番号と説明付きでリントレポートが表示されます。左のエディターで問題を修正すると、レポートは自動的に更新されます。コピーまたはダウンロードでレポートを保存できます。
修正して再リント
各問題に対処して再実行してください。MarkdownをHTMLに変換するにはMarkdownをHTMLにを、見出しから目次を生成するにはMarkdown目次ジェネレーターを使用してください。
Markdownリントが役立つ場面
GitHubにドキュメントをコミットする前やCMSに公開する前に、リントはレンダリングを壊したり読者を混乱させたりする可能性のある問題を検出します。一貫しない見出し階層は目次を信頼できなくします。壊れた参照リンクは404を引き起こします。ここでMarkdownを実行するとレビュー前の品質が向上します。
ドキュメントサイト、READMEファイル、ブログ記事は一貫したMarkdownの恩恵を受けます。HTMLへの変換にはMarkdownをHTMLにを、見出しから目次を生成するにはMarkdown目次ジェネレーターを、構文リファレンスにはMarkdownチートシートを使用してください。
よくある質問
データはプライベートですか?
はい。リントはブラウザ内で完全に実行されます。サーバーにデータは送信されません。ブラウザのネットワークタブを開いて確認できます。
何をチェックしますか?
典型的なチェックには、見出しの一貫性、ブロック周囲の空行、リストのフォーマット、リンクの有効性、CommonMark/GFM準拠が含まれます。正確なルールは実装に依存します。
リンターとバリデーターの違いは?
リンターはスタイルとベストプラクティスに焦点を当てます。バリデーターは構文の正確性をチェックします。品質のために両方を使用してください。Markdownバリデーターで検証を試してください。
GFMはサポートしていますか?
多くのリンターはGitHub Flavored Markdown(テーブル、タスクリスト、取り消し線)をサポートしています。GFM固有の問題についてはレポートを確認してください。
問題を自動で修正できますか?
このツールは問題を報告します。手動で修正してください。フォーマット(空白、改行)にはMarkdownフォーマッターを使用してください。
関連ツール
Markdown構文はCommonMarkとCommonMark仕様を参照。GitHub Flavored Markdownが拡張しています。Markdown Guideでチュートリアルを提供。GitHub、W3C HTML、Jekyllも参照。