Add Markdown Linting #726
Add Markdown Linting #726
Conversation
enables all rules that do not currently trigger any warnings or issues
There should be 0 or 2 trailing spaces.
- fixes a broken link in the graphql guides - fixes a duplicate url reference in the Git guides
also removes an extraneous url reference
| @@ -0,0 +1,2 @@ | |||
| [tools] | |||
| node = "latest" | |||
There was a problem hiding this comment.
neat! I had not heard of mise before. Sort of like a make meets asdf type deal?
I'm curious what the majority of people use for a language management system at thoughtbot. I think I would assume that asdf is the most default but I have no idea.
Would you be opposed to also adding a .tool-versions file?
There was a problem hiding this comment.
👍 I wouldn't be opposed to adding .tool-versions
mise is a drop in replacement for asdf. I swapped to it after asdf v0.16 broke a whole bunch of things and I couldn't get node or something to installl
| @@ -3,11 +3,11 @@ | |||
| Use [Suspenders]: | |||
|
|
|||
| ```sh | |||
| $ gem install suspenders | |||
There was a problem hiding this comment.
This is an interesting one. I have mixed feelings about $ to prevent whole "copy paste didn't read" interactions. On one hand it's probably good we do that. On the other, it's probably confusing to devs who aren't used to the syntax. Wondering if anyone has stronger opinions on it
There was a problem hiding this comment.
I compared this to other code blocks marked with console/shell etc, and all of the other instances did not include the $ or other marker. My preference would be not adding in $, but it's not a strong opinion. Whichever way we went, I'd recommend making it consistent everywhere.
markdownlint-cli2to lint the markdown fileslefthookand a pre-commit hook to run markdownlint on staged changes