-
Notifications
You must be signed in to change notification settings - Fork 5
Open
Description
概要
現状はMD025 single-title/single-h1 - Multiple top-level headings in the same documentが false になっているだけで、Markdownlintがあまり機能しているとは言えません。
過去のPull Requestで付けられたレビューコメントを参照して、Markdownlintの検知対象としても良さそうな内容を抽出します。
やらないこと
文言の修正はMarkdownlintで検知できないため対象外です。文言に関してなんらかのlintを実行したい場合はtextlintのような自然言語に対するlintを実行できるライブラリを導入しましょう。
箇条書きになっていない部分を箇条書きにするよう促したり、見出しレベルの修正を促したりすることはMarkdownlintだとできないはずなので、スコープ外とします(該当のレビューがあるPull Request)。
検知対象追加の案
検知対象の候補と該当するルールのリンクを括弧内に記載しています。補足でこのリポジトリ内での事例のURLを掲載します。
- 見出しレベルが一段階ずつ増えるようにする (MD001 heading-increment - Heading levels should only increment by one level at a time)
- 見出しの下に空行を挿入する (MD022 blanks-around-headings - Headings should be surrounded by blank lines)
- 順序付きリスト記法を使う場合、連続して「1.」を書くのではなく「1.」「2.」「3.」と連番で書く (MD029 ol-prefix - Ordered list item prefix)
- 順序付きリスト記法を使う場合、数字とドットの並びの後に空白を入れる (MD030 list-marker-space - Spaces after list markers)
- HTMLによるマークアップをMarkdown内へ含めないようにする (MD033 no-inline-html - Inline HTML)
関連リンク
nishimotz
Metadata
Metadata
Assignees
Labels
No labels