Skip to content
This repository has been archived by the owner on Jan 29, 2024. It is now read-only.

Add Markdown Linting #275

Open
1 of 3 tasks
kjaymiller opened this issue Nov 28, 2023 · 0 comments
Open
1 of 3 tasks

Add Markdown Linting #275

kjaymiller opened this issue Nov 28, 2023 · 0 comments
Assignees
Labels

Comments

@kjaymiller
Copy link
Owner

kjaymiller commented Nov 28, 2023

Our markdown files are not linted. This means that we can bad formatting and other issues that are not caught by the build process. We should add a markdown linter to our build process.

We can lint via pre-commit. There is a tool call markdownlint-cli that is used by pre-commit and VS Code. We can add a pre-commit hook and use the same config build process that will lint our markdown files.

Steps

  • Add markdownlint-cli to devcontainer
  • Add markdownlint-cli to pre-commit
  • Add .markdownlint.json to root and the projectpath
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

1 participant