mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2025-12-23 01:10:13 +01:00
34 lines
844 B
Markdown
34 lines
844 B
Markdown
|
|
# MD014 - Dollar signs used before commands without showing output
|
||
|
|
|
||
|
|
Tags: code
|
||
|
|
|
||
|
|
Aliases: commands-show-output
|
||
|
|
|
||
|
|
This rule is triggered when there are code blocks showing shell commands to be
|
||
|
|
typed, and the shell commands are preceded by dollar signs ($):
|
||
|
|
|
||
|
|
$ ls
|
||
|
|
$ cat foo
|
||
|
|
$ less bar
|
||
|
|
|
||
|
|
The dollar signs are unnecessary in the above situation, and should not be
|
||
|
|
included:
|
||
|
|
|
||
|
|
ls
|
||
|
|
cat foo
|
||
|
|
less bar
|
||
|
|
|
||
|
|
However, an exception is made when there is a need to distinguish between
|
||
|
|
typed commands and command output, as in the following example:
|
||
|
|
|
||
|
|
$ ls
|
||
|
|
foo bar
|
||
|
|
$ cat foo
|
||
|
|
Hello world
|
||
|
|
$ cat bar
|
||
|
|
baz
|
||
|
|
|
||
|
|
Rationale: it is easier to copy and paste and less noisy if the dollar signs
|
||
|
|
are omitted when they are not needed. See
|
||
|
|
<http://www.cirosantilli.com/markdown-styleguide/#dollar-signs-in-shell-code>
|
||
|
|
for more information.
|