Skip to content
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

doc: fix broken markdown/display in cli.html #34892

Merged
merged 1 commit into from
Aug 26, 2020
Merged

doc: fix broken markdown/display in cli.html #34892

merged 1 commit into from
Aug 26, 2020

Conversation

Trott
Copy link
Member

@Trott Trott commented Aug 23, 2020

The < character is interpreted as the start of an HTML tag, making the
word address not render and the rest of the document rendered with a
grey background and in italics. Use &lt; instead.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

Before:

image

After:

image

@nodejs-github-bot nodejs-github-bot added cli Issues and PRs related to the Node.js command line interface. doc Issues and PRs related to the documentations. labels Aug 23, 2020
The `<` character is interpreted as the start of an HTML tag, making the
word `address` not render and the rest of the document rendered with a
grey background and in italics. Use `&lt;` instead.

PR-URL: nodejs#34892
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
@Trott
Copy link
Member Author

Trott commented Aug 26, 2020

Landed in a7572d1

@Trott Trott deleted the lt branch August 26, 2020 13:42
richardlau pushed a commit that referenced this pull request Sep 1, 2020
The `<` character is interpreted as the start of an HTML tag, making the
word `address` not render and the rest of the document rendered with a
grey background and in italics. Use `&lt;` instead.

PR-URL: #34892
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
@richardlau richardlau mentioned this pull request Sep 2, 2020
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli Issues and PRs related to the Node.js command line interface. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants