Skip to content

Markdownlintの検知対象を拡張する #294

@kubosho

Description

@kubosho

概要

現状はMD025 single-title/single-h1 - Multiple top-level headings in the same documentfalse になっているだけで、Markdownlintがあまり機能しているとは言えません。

過去のPull Requestで付けられたレビューコメントを参照して、Markdownlintの検知対象としても良さそうな内容を抽出します。

やらないこと

文言の修正はMarkdownlintで検知できないため対象外です。文言に関してなんらかのlintを実行したい場合はtextlintのような自然言語に対するlintを実行できるライブラリを導入しましょう。

箇条書きになっていない部分を箇条書きにするよう促したり、見出しレベルの修正を促したりすることはMarkdownlintだとできないはずなので、スコープ外とします(該当のレビューがあるPull Request)。

検知対象追加の案

検知対象の候補と該当するルールのリンクを括弧内に記載しています。補足でこのリポジトリ内での事例のURLを掲載します。

関連リンク

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions