tools: add remark-lint configuration in .remarkrc #7729
Conversation
ChALkeR
added
doc
|
Once this lands, I will propose That should prevent future errors like the ones fixed in #7637 (that fixed several actual errors that broke something in the docs, not just formatting issues) and #7590. |
|
Mostly a rubber stamp LGTM. Linting the docs is a great idea. |
|
👍 Is it capable of finding errors in the relative links (especially in the fragment identifiers)? That would be awesome. |
That'd be glorious indeed. |
I doubt it, the doctool generates its own non-standard format for the anchors (I think that’s done so that there are no duplicates in the generated I’ve been occasionally using my own tooling for that, but it needs to be applied to the generated HTML docs instead of the source. |
|
I think this file shoudn't need to be top-level for a couple of reasons.
Sorry, strong -1 in this form. But the intention should be picked up for sure. |
|
@eljefedelrodeodeljefe Would you think differently about this if |
|
yes. |
|
@eljefedelrodeodeljefe, this is valuable even without proper tooling on our side (though I plan to add such tooling, just wanted to keep things separate) — code editors (e.g. Atom with Nevertheless, I will probably file a pull request with actual |
|
hmm. Valid point - some at least. Maybe just hold off on that until we have done actual work on proper tooling and we integrate that right away. That would decrease module bloat at least and we wouldn't continue with the patch work. |
Use blockquotes instead of code blocks for stability markers in the docs. Doing that: - Makes the makers appear correctly when viewed e.g. on github. - Allows remark-lint rules like `no-undefined-references` to work properly (nodejs#7729).
Use blockquotes instead of code blocks for stability markers in the docs. Doing that: - Makes the makers appear correctly when viewed e.g. on github. - Allows remark-lint rules like `no-undefined-references` to work properly (nodejs#7729).
|
/cc @Trott |
|
LGTM |
|
Rubber stamp LGTM |
Use blockquotes instead of code blocks for stability markers in the docs. Doing that: - Makes the makers appear correctly when viewed e.g. on github. - Allows remark-lint rules like `no-undefined-references` to work properly (#7729). PR-URL: #7757 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Сковорода Никита Андреевич <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
ChALkeR
force-pushed
the
remark-config
branch
2 times, most recently
from
6de0414 to
c4d7271
Compare
|
Yay, I removed the I have added one more commit because another error made it to the docs while this was here, could someone review that one too? Should be trivial. /cc @nodejs/collaborators @eljefedelrodeodeljefe I still don't see the reason to hold this util the tooling is ready, this at least defines some rules that could help to find errors in the docs. Going to land this if no objections. |
|
Thanks, all! Landed in b779eb4...4c86fa3. |
Use blockquotes instead of code blocks for stability markers in the docs. Doing that: - Makes the makers appear correctly when viewed e.g. on github. - Allows remark-lint rules like `no-undefined-references` to work properly (#7729). PR-URL: #7757 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Сковорода Никита Андреевич <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Roman Reiss <[email protected]> Conflicts: doc/api/punycode.md
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: #7637 Refs: #7727 Refs: #7757 PR-URL: #7729 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Robert Jefe Lindstaedt <[email protected]>
This fixes a markdown formatting error in 2016-07-13 CTC meeting minutes, __proto__ was rendered incorrectly. This was found by remark-lint. PR-URL: #7729 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Robert Jefe Lindstaedt <[email protected]>
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: #7637 Refs: #7727 Refs: #7757 PR-URL: #7729 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Robert Jefe Lindstaedt <[email protected]>
This fixes a markdown formatting error in 2016-07-13 CTC meeting minutes, __proto__ was rendered incorrectly. This was found by remark-lint. PR-URL: #7729 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Robert Jefe Lindstaedt <[email protected]>
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: #7637 Refs: #7727 Refs: #7757 PR-URL: #7729 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Robert Jefe Lindstaedt <[email protected]>
This fixes a markdown formatting error in 2016-07-13 CTC meeting minutes, __proto__ was rendered incorrectly. This was found by remark-lint. PR-URL: #7729 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Robert Jefe Lindstaedt <[email protected]>
Use blockquotes instead of code blocks for stability markers in the docs. Doing that: - Makes the makers appear correctly when viewed e.g. on github. - Allows remark-lint rules like `no-undefined-references` to work properly (nodejs#7729). PR-URL: nodejs#7757 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Сковорода Никита Андреевич <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
Use blockquotes instead of code blocks for stability markers in the docs. Doing that: - Makes the makers appear correctly when viewed e.g. on github. - Allows remark-lint rules like `no-undefined-references` to work properly (#7729). PR-URL: #7757 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Сковорода Никита Андреевич <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
Use blockquotes instead of code blocks for stability markers in the docs. Doing that: - Makes the makers appear correctly when viewed e.g. on github. - Allows remark-lint rules like `no-undefined-references` to work properly (#7729). PR-URL: #7757 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Сковорода Никита Андреевич <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
Use blockquotes instead of code blocks for stability markers in the docs. Doing that: - Makes the makers appear correctly when viewed e.g. on github. - Allows remark-lint rules like `no-undefined-references` to work properly (#7729). PR-URL: #7757 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Сковорода Никита Андреевич <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
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: #7637 Refs: #7727 Refs: #7757 PR-URL: #7729 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Robert Jefe Lindstaedt <[email protected]>
This fixes a markdown formatting error in 2016-07-13 CTC meeting minutes, __proto__ was rendered incorrectly. This was found by remark-lint. PR-URL: #7729 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Robert Jefe Lindstaedt <[email protected]>
Use blockquotes instead of code blocks for stability markers in the docs. Doing that: - Makes the makers appear correctly when viewed e.g. on github. - Allows remark-lint rules like `no-undefined-references` to work properly (#7729). PR-URL: #7757 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Сковорода Никита Андреевич <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
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: #7637 Refs: #7727 Refs: #7757 PR-URL: #7729 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Robert Jefe Lindstaedt <[email protected]>
This fixes a markdown formatting error in 2016-07-13 CTC meeting minutes, __proto__ was rendered incorrectly. This was found by remark-lint. PR-URL: #7729 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Robert Jefe Lindstaedt <[email protected]>
Use blockquotes instead of code blocks for stability markers in the docs. Doing that: - Makes the makers appear correctly when viewed e.g. on github. - Allows remark-lint rules like `no-undefined-references` to work properly (#7729). PR-URL: #7757 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Сковорода Никита Андреевич <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
|
Excuse me asking, but how does one run the markdown linter? Is it not included in |
|
@silverwind Ah, the tooling is included in a separate PR: #8551 The current configuration works if you have The tooling PR got stalled because I didn't have enough time to fix CI support, but I'm going to continue that soon, and probably make the CI support a separate issue to get the tooling landed faster. |
|
Thanks. I managed to run it with We have 174 lines that exceed 80 characters, yay. |
Checklist
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
*.mdfiles (ignoring thirdparty), once #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.