Closed Potherca closed 3 years ago
Good points.
I've been thinking about that as well. Not just for Remark, but regarding the other GitHub actions we run... There seems to be a lot of implicit knowledge assumed, which is a bad sign.
I've created a separate issue for documenting how to run all of the QA tools in our current pipeline and continue this conversation there: #123
Merging without re-review as there are no new changes, just a rebase of already reviewed changes.
Proposed Changes
This MR adds a configuration file for Remark, so there is now one consistent way Markdown should be written in this repo. The configuration uses the
lint-recommended
preset, with as only exception that thelist-item-indent
has been set to only require a single space after a list character (as opposed to the multi-space default).Other than a few links in the README, all markdown files in the repo already adhere to this standard.
As there is already a GitHub action that runs Remark, no other changes are needed.
Related Issues
This MR is inspired by the comment from @jrfnl in #118 regarding inconsistencies in my Markdown. I suggested adding a Remark config, so here it is! :grin: