-
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
doc: use consistent markdown in README #7971
Conversation
|
||
``` | ||
```shell |
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.
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 disagree, but I'm open to be persuaded. Bike shed time, I guess but here are the reasons:
- This is a shell command. It may be bash. Or it maybe csh or zsh or tcsh or even Windows PowerShell. There is nothing bash-specific about
curl
. - If
shell
is not more appropriate than bash here, then when would it ever be more appropriate? - This is more of an argument that it doesn't matter than that one or the other is right, but
bash
is an alias forshell
in the syntax highlighting tool used by GitHub Flavored Markdown so there is no difference in the rendered output of one versus the other.
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.
¯_(ツ)_/¯
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.
This should be either «```console» or commands should not start with «$».
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.
Done.
Improve markdown practices in README: * consistent header indicators * consistent emphasis indicators * wrap bare URLs in `<` and `>` * wrap at 80 chars * specifying language in fenced code
$ curl -O https://nodejs.org/dist/vx.y.z/SHASUMS256.txt | ||
``` | ||
|
||
To check that a downloaded file matches the checksum, run | ||
it through `sha256sum` with a command such as: | ||
|
||
``` | ||
```shell |
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.
ditto
|
||
The full set of trusted release keys can be imported by running: | ||
|
||
``` | ||
```console |
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.
This either shouldn't be «```console» or the lines should start with a prompt like «$ » or «> ».
Or this is going to be formatted like text output.
I would just use sh
or shell
here (in this specific block), perhaps.
One issue with a code block language specification ( |
@ChALkeR Switched that one instance to |
@Trott Ah, noticed one more thing. $ gpg --keyserver pool.sks-keyservers.net \
--recv-keys DD8F2338BAE7501E3DD5AC78C273792F7D83545D is inaccurate and gets wrong highlight. It should be either gpg --keyserver pool.sks-keyservers.net \
--recv-keys DD8F2338BAE7501E3DD5AC78C273792F7D83545D or $ gpg --keyserver pool.sks-keyservers.net \
> --recv-keys DD8F2338BAE7501E3DD5AC78C273792F7D83545D |
@ChALkeR I suppose another option is just to get rid of the line break and have it be a single line by itself. Does that work for you? |
@Trott Yes, it does, it doesn't break the It does break a guideline rule regarding the sources code style, but there is no other way to achieve a similar display and this looks like a valid reason for an exception. We already have those in other places (long links, for example). LGTM. |
LGTM |
LGTM! |
Continuing what a58b48b did for the doc/ dir, this fixes some formatting issues in the *.md files that are placed directly in the top-level directory. README.md changes are excluded as they are covered by nodejs#7971 Refs: nodejs#7637 PR-URL: nodejs#7727 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Improve markdown practices in README: * consistent header indicators * consistent emphasis indicators * wrap bare URLs in `<` and `>` * wrap at 80 chars * specifying language in fenced code PR-URL: #7971 Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Landed in cc3a9e7! |
Continuing what a58b48b did for the doc/ dir, this fixes some formatting issues in the *.md files that are placed directly in the top-level directory. README.md changes are excluded as they are covered by #7971 Refs: #7637 PR-URL: #7727 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Improve markdown practices in README: * consistent header indicators * consistent emphasis indicators * wrap bare URLs in `<` and `>` * wrap at 80 chars * specifying language in fenced code PR-URL: #7971 Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Improve markdown practices in README: * consistent header indicators * consistent emphasis indicators * wrap bare URLs in `<` and `>` * wrap at 80 chars * specifying language in fenced code PR-URL: #7971 Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Improve markdown practices in README: * consistent header indicators * consistent emphasis indicators * wrap bare URLs in `<` and `>` * wrap at 80 chars * specifying language in fenced code PR-URL: #7971 Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Improve markdown practices in README: * consistent header indicators * consistent emphasis indicators * wrap bare URLs in `<` and `>` * wrap at 80 chars * specifying language in fenced code PR-URL: #7971 Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Improve markdown practices in README: * consistent header indicators * consistent emphasis indicators * wrap bare URLs in `<` and `>` * wrap at 80 chars * specifying language in fenced code PR-URL: #7971 Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Checklist
Affected core subsystem(s)
doc
Description of change
Changes include:
<
and>
Linting tool possibly on the way.