Markdown lint
多くのエディターやCIパイプラインで使われているリンター、markdownlintで、Markdownのスタイルや構文の問題をチェックします。文書を貼り付けると、MD001などのルール名と説明を、該当行とともにすべて表示します。必要に応じて、空行、リストマーカー、スペースなど、markdownlintで修正できる箇所を直したバージョンも取得できます。
よくある質問
どのルールがチェックされますか?
見出しレベルを1つずつ上げるMD001から、リスト、空行、コードブロック、リンク、強調に関するルールまで、markdownlintで初期設定で有効になっているすべてのルールが対象です。行の長さをチェックするMD013は、最大行長を設定しない限り無効です。
ルールを無効にするにはどうすればよいですか?
無効にするルール欄に、MD033などの番号またはno-inline-htmlなどの名前を、カンマまたはスペースで区切って入力します。<!-- markdownlint-disable MD033 -->のような文書内のインラインコメントも使えます。
修正オプションでは何ができますか?
markdownlintが提供する自動修正を適用します。見出しやリストの前後に空行を追加する、リストマーカーを統一する、末尾のスペースを削除するなどの修正を行い、修正後の文書を表示します。自動修正できない指摘は残るため、手動で修正してください。
どのバージョンのmarkdownlintが使われていますか?
markdownlint 0.42.0を使用しています。これはVisual Studio Code用markdownlint拡張機能とmarkdownlint-cli2の基盤となるライブラリです。同じバージョンと初期設定を使えば、どちらも同じ指摘を報告します。
最初の見出しについて警告されるのはなぜですか?
ルールMD041は文書を最上位の見出しから始めることを求め、MD025は最上位の見出しを1つだけに制限します。使用しているプラットフォームがタイトルを自動で追加する場合は、その文書ではこれらのルールを無効にしてください。
指摘はいくつ表示されますか?
指摘の合計数は常に報告され、最初の500件は表に表示されます。まず最初の指摘を修正してから再チェックすると、残りの指摘を確認できます。