-
Notifications
You must be signed in to change notification settings - Fork 29.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 <DerekNonGeneric@inf.is>
Co-authored-by: Derek Lewis <DerekNonGeneric@inf.is>
Co-authored-by: Derek Lewis <DerekNonGeneric@inf.is>
Co-authored-by: Derek Lewis <DerekNonGeneric@inf.is>
Co-authored-by: Derek Lewis <DerekNonGeneric@inf.is>
Co-authored-by: Derek Lewis <DerekNonGeneric@inf.is>
Co-authored-by: Derek Lewis <DerekNonGeneric@inf.is>
Co-authored-by: Derek Lewis <DerekNonGeneric@inf.is>
Co-authored-by: Derek Lewis <DerekNonGeneric@inf.is>
Co-authored-by: Derek Lewis <DerekNonGeneric@inf.is>
Co-authored-by: Derek Lewis <DerekNonGeneric@inf.is>
These are changed to either ```text or ```console. PR-URL: nodejs#33028 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
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 <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
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 <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
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 <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
These are changed to either ```text or ```console. PR-URL: #33028 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
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 <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
These are changed to either ```text or ```console. PR-URL: #33028 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
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 <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
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 <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
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 <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
The PR normalizes
txt
,fundamental
, andraw
fenced code blocks in markdown files to usetext
as the info string (i.e. language).Resolves #32938
Checklist
cc @nodejs/documentation