docs: normalize plaintext code blocks#33028
Conversation
|
@zeke, I have a couple of concerns w/ your PR. The primary one being that we aren't nipping this in the bud. Ideally, we would be banning the |
|
Okay. Happy to help with an update to https://github.com/nodejs/remark-preset-lint-node if that seems like the right course of action.
Looks like @Trott has already weighed in there. Were you expecting further comment? |
Absolutely. If not in that particular issue, in this PR (or elsewhere). I would give it some time. |
DerekNonGeneric
left a comment
DerekNonGeneric
left a comment
There was a problem hiding this comment.
I've put a bit more thought into exactly what info strings are available and what they all mean. I will followup this review comment w/ a PR augmenting the documentation guide clarifying my suggestions. Hopefully, it will be persuasive enough to take these suggestions. :)
Co-authored-by: Derek Lewis <[email protected]>
Co-authored-by: Derek Lewis <[email protected]>
Co-authored-by: Derek Lewis <[email protected]>
Co-authored-by: Derek Lewis <[email protected]>
Co-authored-by: Derek Lewis <[email protected]>
Co-authored-by: Derek Lewis <[email protected]>
Co-authored-by: Derek Lewis <[email protected]>
Co-authored-by: Derek Lewis <[email protected]>
Co-authored-by: Derek Lewis <[email protected]>
Co-authored-by: Derek Lewis <[email protected]>
Co-authored-by: Derek Lewis <[email protected]>
BridgeAR
added
the
author ready
These are changed to either ```text or ```console. PR-URL: nodejs#33028 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
|
Landed in f08174c |
|
/re #33028 (comment) and #33028 (comment) After updating the bundle to include the HTTP grammar, I noticed that although this is an HTTP request [almost] following HTTP semantics, it also includes linebreak escape characters. This results in the sub-par highlighting as seen below. :(
I wonder if this is a deficiency in the highlighter's regex or this should have actually been
/cc @jasnell |
In the particular case from your screenshot, I think removing |
These are changed to either ```text or ```console. PR-URL: #33028 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
This commit adds the list of agreed-upon info strings to the documentation style guide to aid with future development and maintenance. Refs: #33510 Refs: #33507 Refs: #33483 Refs: #33531 Refs: #33542 Refs: #33028 Refs: #33548 Refs: #33486 PR-URL: #34024 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
This commit adds the list of agreed-upon info strings to the documentation style guide to aid with future development and maintenance. Refs: #33510 Refs: #33507 Refs: #33483 Refs: #33531 Refs: #33542 Refs: #33028 Refs: #33548 Refs: #33486 PR-URL: #34024 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
These are changed to either ```text or ```console. PR-URL: #33028 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
This commit adds the list of agreed-upon info strings to the documentation style guide to aid with future development and maintenance. Refs: #33510 Refs: #33507 Refs: #33483 Refs: #33531 Refs: #33542 Refs: #33028 Refs: #33548 Refs: #33486 PR-URL: #34024 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
These are changed to either ```text or ```console. PR-URL: #33028 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
This commit adds the list of agreed-upon info strings to the documentation style guide to aid with future development and maintenance. Refs: #33510 Refs: #33507 Refs: #33483 Refs: #33531 Refs: #33542 Refs: #33028 Refs: #33548 Refs: #33486 PR-URL: #34024 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
This commit adds the list of agreed-upon info strings to the documentation style guide to aid with future development and maintenance. Refs: #33510 Refs: #33507 Refs: #33483 Refs: #33531 Refs: #33542 Refs: #33028 Refs: #33548 Refs: #33486 PR-URL: #34024 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
This commit adds the list of agreed-upon info strings to the documentation style guide to aid with future development and maintenance. Refs: #33510 Refs: #33507 Refs: #33483 Refs: #33531 Refs: #33542 Refs: #33028 Refs: #33548 Refs: #33486 PR-URL: #34024 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
6 participants
The PR normalizes
txt,fundamental, andrawfenced code blocks in markdown files to usetextas the info string (i.e. language).Resolves #32938
Checklist
cc @nodejs/documentation