Skip to content

README: use the console language to present examples#470

Open
matttbe wants to merge 1 commit into
arighi:mainfrom
matttbe:readme-console
Open

README: use the console language to present examples#470
matttbe wants to merge 1 commit into
arighi:mainfrom
matttbe:readme-console

Conversation

@matttbe
Copy link
Copy Markdown
Collaborator

@matttbe matttbe commented May 11, 2026

I recently discovered this mode that is specially there to better present shell sessions, where commands are prefixed with $, #, etc.

The previous 'shell' mode is to present shell scripts, where these prefixes are not used, and thus the colouring can appear a bit random. Here with 'console', lines not prefixed with such characters are seen as "output" and they appear in a different colour, making it easier to spot commands vs output.

In the Quick start section, there was a small indentation that was not needed, and made all the lines appears as "output".

See the diff: original - new

I recently discovered this mode that is specially there to better
present shell sessions, where commands are prefixed with $, #, etc.

The previous 'shell' mode is to present shell scripts, where these
prefixes are not used, and thus the colouring can appear a bit random.
Here with 'console', lines not prefixed with such characters are seen as
"output" and they appear in a different colour, making it easier to spot
commands vs output.

In the Quick start section, there was a small indentation that was not
needed, and made all the lines appears as "output".

Link: https://github.com/github-linguist/linguist/blob/e535c9adf5306132e9df0b75ffe1ce2679873fe8/lib/linguist/languages.yml#L7269-L7280
Signed-off-by: Matthieu Baerts (NGI0) <matttbe@kernel.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant