Skip to content

pre-commit: add markdownlint and standardize Markdown files #29

@jbampton

Description

@jbampton

Popular tool to standardize a projects Markdown

https://github.com/DavidAnson/markdownlint

Using the CLI with pre-commit:

https://github.com/igorshubovych/markdownlint-cli?tab=readme-ov-file#use-with-pre-commit

So we can have another basic check / hook / test running with pre-commit.

Nice to have standardized and formatted Markdown

So there are about 40+ rules that you can enable/disable and various ways to use ignores

https://github.com/DavidAnson/markdownlint?tab=readme-ov-file#rules--aliases

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