Good to have some linting on our Markdown files as well.
I'm a little bit tactical about choosing remark-lint here because I want to later introduce Codacy, and they support remark-lint. Besides, remark-lint is pretty nice either way.
Applied remark . -o, fixing all tiny fixable things
Manually fix lint warnings, mostly line length and code block lang
Changed built-in var list to headers instead of table, mostly to comply with 80 character width limit, but also so it's easier to extend with more docs later.
Moved the-wharf-ci-yml-file.md to just using-wharfyml.md to comply with no-file-name-articles
Good to have some linting on our Markdown files as well.
I'm a little bit tactical about choosing remark-lint here because I want to later introduce Codacy, and they support remark-lint. Besides, remark-lint is pretty nice either way.
I chose to use their remark-preset-lint-markdown-style-guide starting template as it got a lot right going for it, but then I added some other overrides in
.remarkrc
that I though were sane and matched with how we write markdown. Theremark-stringify
settings use these "mdast-util" settings: https://github.com/syntax-tree/mdast-util-to-markdown#formatting-optionsChanges
remark . -o
, fixing all tiny fixable thingsthe-wharf-ci-yml-file.md
to justusing-wharfyml.md
to comply with no-file-name-articlesPreview