Skip to content

tools: add remark-lint configuration in .remarkrc

Rodrigo Muino Tomonari requested to merge github/fork/ChALkeR/remark-config into master
Checklist
  • commit message follows commit guidelines
Affected core subsystem(s)

tools, doc

Description of change

Specifies the configuration for remark-lint, a markdown linter.

This configuration will not cause any warnings on any of the currently present *.md files (ignoring thirdparty), once https://github.com/nodejs/node/pull/7727 lands (hence blocked now).

It is useful not only for possible future tooling that would check the markdown files syntax, but also as a configuration for editor plugins, e.g. linter-markdown for atom-linter.

Issues fixed in #7637 and #7727 were mostly found using remark-lint.

/cc @nodejs/documentation @addaleax @silverwind @mscdex @Fishrock123.

Merge request reports