Add .markdownlintrc config file for markdownlint #1571
Conversation
This configures `markdownlint`, a Markdown linter/formatter, to follow the Google style guide for Markdown as closely as possible. This allows users to use `markdownlint` when writing and editing Markdown files, and gets us ready to add a Markdown linter check in the CI workflow.
|
what's the intended use? we have very few true markdown files in the repository. (a lot more if you count docstrings, jupyter notebooks, and autogenerated api docs) |
That's a fair question. I'm about to add several more md files; in addition, with the other Quantumlib projects using Markdown more heavily, I hope to see the Qualtran project from rST to md for their docs/ too … (But even if that doesn't happen, there will always be several Markdown files, and IMHO it's worth automating style checks if there's more than one.) |
|
We don't actually use rst either. We use the myst-nb sphinx plugin to take jupyter notebooks (which indeed use markdown cells) and turn them into docs pages via the sphinx doc builder |
Oh, I see. Good to know! I'm examining ipynb linters too, but don't know yet if markdownlint can be made part of that. (Hopefully it can, so that the same config will work everywhere.) |
This configures
markdownlint, a Markdown linter/formatter, to follow the Google style guide for Markdown as closely as possible. This allows users to usemarkdownlintwhen writing and editing Markdown files, and gets us ready to add a Markdown linter check in the CI workflow.