Markdownリンター
Markdownのスタイルと構造の問題を検査します
Markdown入力
Lintレポート
Markdownリンターとは？
Markdownリンターは、Markdownファイルを分析し、スタイル違反、フォーマットの不整合、ドキュメントの読みやすさや保守性を損なう構造的な問題を報告するコード品質ツールです。デスクトップ版のmarkdownlintと同様に、このブラウザベースのリンターはローカルで実行され、コンテンツをどこにもアップロードすることなく問題を特定します。リンティングにより、すべてのMarkdownファイルが一貫したルールに従い、よりプロフェッショナルでチームでも使いやすくなります。
ほとんどのMarkdownリンターは、見出しレベルの不正なネスト（H1から直接H3にジャンプ）、不自然に折り返す過度な行の長さ、一貫性のないリストマーカー（箇条書きスタイルの混在）、見出し周りの空行の欠如などの問題をチェックします。markdownlintプロジェクトは、末尾のスペースからコードフェンスの一貫性まで、40以上の異なるルールを含む業界標準となっている包括的なルールセットを定義しています。
これらの問題を早期に発見することで、Markdownリンターはドキュメントレビュー中の時間を節約し、読者の混乱を防ぎます。ここで採用しているブラウザベースのアプローチにより、外部依存なしでMarkdownへの即時フィードバックが得られ、ドキュメント、README、ブログ投稿、技術ガイドのリアルタイム作成に最適です。
Markdownリンターの使い方
Markdownのスタイルと構造を検査するには以下の手順に従ってください。各ステップはこのページの実際のボタンとパネルを使用します。
貼り付け、アップロード、またはサンプルを読み込む
左側のMarkdown入力パネルにMarkdownを貼り付けるか、アップロードをクリックして.mdファイルを読み込みます。サンプルをクリックして意図的なスタイルの問題を含むサブスクライバーAPIドキュメントの例を確認できます。見出し階層、行の長さ、リストの一貫性、末尾の空白を検査します。
Lintレポートを確認する
右側のLintレポートパネルに行番号と説明付きの問題一覧が表示されます。見出しジャンプ、長い行、混在するリストマーカー、スペーシングの問題を修正してください。
レポートをコピーまたはダウンロード
コピーまたはダウンロードをクリックしてレポートを使用します。クリアで最初からやり直せます。すべての処理はブラウザで実行されます。
実際の使用場面
ドキュメントレビューワークフロー
ドキュメント更新のプルリクエストを送る前に、リンターを実行してスタイル違反を検出します。これによりプロジェクトのドキュメント全体の一貫性を確保し、フォーマットの問題についてのレビュアーとのやりとりを減らすことができます。GitHub Docsのような大規模なドキュメントサイトを管理するチームは、CI/CDパイプラインで同様のツールを使用しています。
テクニカルライティング標準
ブログ投稿、チュートリアル、ガイド全体で一貫した見出し構造とフォーマットを適用します。プロフェッショナルな外観を維持し、読者が見出しを使って予測可能にナビゲートできるようにします。dev.toやMediumのようなMarkdown主体のプラットフォームでは特に重要です。
オープンソースプロジェクトの管理
マージする前に、コントリビューターが提出したドキュメントがプロジェクトのスタイルガイドに準拠しているか確認します。ローカルでのlintチェックにより、コントリビューターが問題を作成する前に自己修正できるようになり、管理の負担が軽減されます。多くのプロジェクトがlintをGitHub Actionsワークフローに追加しています。
簡易コンテンツ品質チェック
公開前にREADMEファイル、APIドキュメント、リリースノートの最終確認に使用します。余分なスペースや無効な見出しシーケンスなど、読者に不プロフェッショナルな印象を与える見落としやすい問題を検出します。複数の著者がコンテンツを作成する場合に特に便利です。
よくある質問
リンターとバリデーターの違いは何ですか？
バリデーターはMarkdownが構文的に正しく、適切にレンダリングされるかどうかを確認します。リンターはさらに進んで、スタイルの一貫性とベストプラクティスを適用します。バリデーションはスペルチェック、リンティングは文法チェックのようなものです。markdownlintのドキュメントではこの違いが明確にされています。ファイルは有効なMarkdownでも、lintチェックで失敗する場合があります。
リンターが検査するルールをカスタマイズできますか？
このブラウザベースのリンターは、最も一般的な問題に焦点を当てた組み込みのデフォルトルールセットを使用しています。完全なカスタマイズが必要な場合は、デスクトップ版のmarkdownlintパッケージで設定ファイルを使用して特定のルールを有効・無効にできます。
リンターはMarkdownをサーバーに送信しますか？
いいえ。すべてのlintはJavaScriptを使用してブラウザ内で完全に実行されます。Markdownコンテンツがコンピュータから外に出ることはありません。これにより、プロプライエタリなドキュメント、プライベートプロジェクト、機密情報に対して安全に使用できます。
このリンターはどのMarkdown方言をサポートしていますか？
このリンターは、最も移植性が高く広くサポートされているMarkdown標準であるCommonMark仕様をベースとしています。GitHub Flavored MarkdownはCommonMarkをテーブルと取り消し線で拡張しています。
リンターが見つけた問題をどのように修正しますか？
レポートの各問題には行番号と説明が含まれています。一般的な修正方法：見出しを論理的に並べ替える、末尾のスペースを削除する、見出しの周りに空行を追加する、行を80文字以内に収める、一貫したリストマーカーを使用する。Markdown Guideに詳細な構文例があります。
これを本番ドキュメントの検査に使用できますか？
単発の確認には使用できます。CI/CDパイプラインでの自動適用には、GitHub Actions、GitLab CI、Jenkinsなどのプラットフォームのビルドプロセスにコマンドライン版のmarkdownlint-cliを統合してください。