Skip to content
GitLab

Bump `markdownlint-github` and add formatter

Merged Kate Higa requested to merge kh-bump-mdl into main

This PR:

  • bumps markdownlint-github to latest

  • add formatter configuration. By default, the markdownlint error message doesn't include a link to the rule doc. This configures a formatter which will ensure the error message includes a link to the relevant doc like so:

    CONTRIBUTING.md:7 GH002/no-generic-link-text Avoid using generic link text like `Learn more` or `Click here` [For link: here] https://github.com/github/markdownlint-github/blob/main/docs/rules/GH002-no-generic-link-text.md

I think this is especially helpful because the rule docs might be in either markdownlint-github or markdownlint and we don't want consumers spending time looking for it.