doc: Replace 'shell' language labels (generally with 'console') #4923
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
GitHub uses Linguist for syntax highlighting [1]. Linguist's 'shell' language is for the *language* [2] (e.g. the contents of a `.sh` file). The proper language for a shell session is ShellSession [3], although in this commit I've used the alias 'console' [4]. The Cargo book uses mdBook (src/doc/README.md), mdBook uses Highlight.js [5], and Highlight.js also supports 'console' as an alias for shell sessions [6]. A handful of places where we had been using 'shell' were just command output, not shell sessions (e.g. they lacked a prompt and command). In this commit, I've left those without a language label. [1]: https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting [2]: https://github.com/github/linguist/blob/v5.3.3/lib/linguist/languages.yml#L4208 [3]: https://github.com/github/linguist/blob/v5.3.3/lib/linguist/languages.yml#L4249 [4]: https://github.com/github/linguist/blob/v5.3.3/lib/linguist/languages.yml#L4255 [5]: https://rust-lang-nursery.github.io/mdBook/format/theme/syntax-highlighting.html#syntax-highlighting [6]: https://github.com/isagalaev/highlight.js/blob/9.12.0/src/languages/shell.js#L10
Member
|
@bors: r+ Thanks! |
Contributor
|
📌 Commit bc489e2 has been approved by |
Contributor
bors
added a commit
that referenced
this pull request
Jan 9, 2018
doc: Replace 'shell' language labels (generally with 'console') #GitHub [uses Linguist][1] for syntax highlighting. Linguist's [`shell` language][2] is for the *language* (e.g. the contents of a `.sh` file). The proper language for a shell session is [`ShellSession`][3], although in this commit I've used the [alias `console`][4]. The Cargo book [uses mdBook][4.5], mdBook [uses Highlight.js][5], and Highlight.js [also supports `console` as an alias for shell sessions][6]. A handful of places where we had been using `shell` were just command output, not shell sessions (e.g. they lacked a prompt and command). In this commit, I've left those without a language label. [1]: https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting [2]: https://github.com/github/linguist/blob/v5.3.3/lib/linguist/languages.yml#L4208 [3]: https://github.com/github/linguist/blob/v5.3.3/lib/linguist/languages.yml#L4249 [4]: https://github.com/github/linguist/blob/v5.3.3/lib/linguist/languages.yml#L4255 [4.5]: https://github.com/rust-lang/cargo/tree/f60ece98c10aa3716d037524da4ee989e212fe19/src/doc#requirements [5]: https://rust-lang-nursery.github.io/mdBook/format/theme/syntax-highlighting.html#syntax-highlighting [6]: https://github.com/isagalaev/highlight.js/blob/9.12.0/src/languages/shell.js#L10
Contributor
|
☀️ Test successful - status-appveyor, status-travis |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#GitHub uses Linguist for syntax highlighting. Linguist's
shelllanguage is for the language (e.g. the contents of a.shfile). The proper language for a shell session isShellSession, although in this commit I've used the aliasconsole.The Cargo book uses mdBook, mdBook uses Highlight.js, and Highlight.js also supports
consoleas an alias for shell sessions.A handful of places where we had been using
shellwere just command output, not shell sessions (e.g. they lacked a prompt and command). In this commit, I've left those without a language label.