iver-wharf / iver-wharf.github.io

Documentation of Wharf
https://iver-wharf.github.io
MIT License
2 stars 0 forks source link

Added remark-lint #21

Closed applejag closed 3 years ago

applejag commented 3 years ago

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. The remark-stringify settings use these "mdast-util" settings: https://github.com/syntax-tree/mdast-util-to-markdown#formatting-options

Changes

Preview

Screenshot_2021-04-22_18-06-34