Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions .github/instructions/markdown.instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,8 @@ See [mkdocs admonitions documentation](https://squidfunk.github.io/mkdocs-materi
- Specify the language for syntax highlighting when possible.
- For shell commands, do not include prompts (host name, username, etc.).

When a command includes parameters the reader must change, surround them with angle brackets:

Example:

````markdown
Expand All @@ -325,14 +327,14 @@ echo 'Hello World'
```
````

When a command includes parameters the reader must change, surround them with angle brackets:
Do not prepend dollar signs (`$`) or other prompt characters to shell commands.

Example:

```shell
adb pull <remote_file> <target_destination>
```

Do not prepend dollar signs (`$`) or other prompt characters to shell commands.

## In-Text Keywords

When not in a code block:
Expand Down
Loading