-
Notifications
You must be signed in to change notification settings - Fork 15.3k
Shell code snippets include command prompt #12739
Description
This is a...
- Feature Request
- Bug Report
Problem:
As per the current style guide, snippets of code shouldn't include the command prompt. On several pages there are code snippets that do include a prompt.
In some places this is mixed in with output, eg (Markdown):
```shell $ printf "%s\n" "Foo bar" Foo bar ```
Proposed Solution:
So, the style guide is clear. I'll amend the issue description.
I think a mixture of approaches.
We want to be able to show what to type mixed with sample output. So the style guide should cover that case and explain what to do.
The site generator might need changes to handle highlighting those blocks, treating the initial $ as a hint that the rest of the line is code, and lines not starting with $ as unformatted command output.
Once those changes are made we can go in and PR fixes to use the new style consistently.
Follow style guide: separate commands from output.