summaryrefslogtreecommitdiff
path: root/.remarkrc
AgeCommit message (Collapse)Author
2016-09-27doc: enable no-file-name-articles remark-lint ruleСковорода Никита Андреевич
This renames doc/topics/the-event-loop-timers-and-nexttick.md to doc/topics/event-loop-timers-and-nexttick.md, which looks like a better name for that file and enables no-file-name-articles remark-lint rule to prevent such names in the future. PR-URL: https://github.com/nodejs/node/pull/8713 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Ilkka Myller <ilkka.myller@nodefield.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2016-09-27doc: enable first-heading-level remark-lint ruleСковорода Никита Андреевич
This makes sure that the first heading in all markdown files is h1. Only three files needed to be changed to conform: 1. BUILDING.md 2. CODE_OF_CONDUCT.md 3. doc/onboarding-extras.md Also, .remarkrc is updated to include the `first-heading-level: 1` rule in order to catch similar issues in the future. PR-URL: https://github.com/nodejs/node/pull/8716 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2016-09-25tools: enable more remark-lint rulesСковорода Никита Андреевич
New rules: 1. rule-style 2. strong-marker 3. no-shell-dollars 4. no-inline-padding 5. code-block-style 6. no-multiple-toplevel-headings Fixes to the existing files applied. PR-URL: https://github.com/nodejs/node/pull/8708 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ilkka Myller <ilkka.myller@nodefield.com> Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: James M Snell <jasnell@gmail.com>
2016-09-21tools: update remark configurationСковорода Никита Андреевич
Specify the plugin name as 'remark-lint/', as new remark-cli refused to find it when cwd is different from the directory where node_modules are put. Trailing slash fixes this, as the plugin name gets treated as a path, so `require` works on it. Explicitly specify the list of rules we want to enable, as the new remark-lint is opt-in and doesn't come with any rules by default. Reorder the rules alphabetically. PR-URL: https://github.com/nodejs/node/pull/8666 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com>
2016-08-07tools: add remark-lint configuration in .remarkrcСковорода Никита Андреевич
Specifies the configuration for remark-lint, a markdown linter. This configuration does not cause any warnings on any of the currently present *.md files (ignoring thirdparty). 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. Refs: https://github.com/nodejs/node/pull/7637 Refs: https://github.com/nodejs/node/pull/7727 Refs: https://github.com/nodejs/node/pull/7757 PR-URL: https://github.com/nodejs/node/pull/7729 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>