base-org/pessimism

Markdown Linting Support

Closed this issue · 2 comments

Problem

Many of the existing repo markdown documents are riddled with typos and formatting issues. This can cause confusion for users and is nonetheless poor hygiene. Adding markdown linting will help establish a consistent formatting style for Markdown files.

Problem Solution

  • Integrated markdown linting in CI
  • Make directive to run markdown linter
  • Repo passing markdown linting scan

Hi, I can take this.

I was thinking about markdownlint: https://github.com/avto-dev/markdown-lint, should it be ok?

Hey @alessandromazza98, that'll be fine 🙏🏻