Skip to content

Commit

Permalink
Refactor remark(1) examples in docs to be valid
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Dec 26, 2015
1 parent a1651ab commit fb0cbe8
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 35 deletions.
36 changes: 18 additions & 18 deletions doc/remark.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Specify output.
### `-c`, `--config-path` <_path_>

```sh
remark --config-path remarkrc.json
remark . --config-path remarkrc.json
```

Specify configuration location. This loads an **remarkrc**(5) file which cannot
Expand All @@ -68,7 +68,7 @@ name) in addition to other detected files.
### `-i`, `--ignore-path` <_path_>

```sh
remark --ignore-path .gitignore
remark . --ignore-path .gitignore
```

Specify ignore location. This loads an **remarkignore**(5) file which cannot be
Expand All @@ -78,7 +78,7 @@ name) in addition to other detected files.
### `-s`, `--setting` <_settings_>

```sh
remark --setting "position:false"
remark readme.md --setting commonmark:true
```

Specify settings (see **remarksetting**(7)). This must be a valid JSON object
Expand All @@ -88,7 +88,7 @@ for more information.
### `-u`, `--use` <_plugin_>

```sh
remark --use man
remark readme.md --use man
```

Specify a plug-in to use, optionally with options. See **remarkplugin**(7)
Expand All @@ -97,7 +97,7 @@ COMMAND LINE USAGE for more information.
### `-e`, `--ext` <_extensions_>

```sh
remark --ext doc
remark . --ext doc
```

Specify one or more extensions to include when searching for files.
Expand All @@ -109,7 +109,7 @@ The given `extensions` can be comma or semi-colon separated.
### `-w`, `--watch`

```sh
remark -w .
remark . -w
```

Watch all files and reprocess when they change.
Expand All @@ -130,64 +130,64 @@ The watch is stopped when `SIGINT` is received (usually done by pressing
### `-a`, `--ast`

```sh
remark --ast
remark readme.md --ast
```

Instead of outputting document the internally used AST is exposed.

### `-q`, `--quiet`

```sh
remark --quiet
remark readme.md --quiet
```

Do not output non-essential text, only warnings and errors.

### `-S`, `--silent`

```sh
remark --silent
remark readme.md --silent
```

Same as `-q`, `--quiet`, but also ignores warnings.
Do not output non-essential text or warning, only errors.

### `-f`, `--frail`

```sh
remark --frail
remark readme.md --frail
```

Exit with a status code of `1` if warnings are triggered for the processed
code, instead of the default of only exiting with `1` on fatal errors.
Exit with a status code of `1` if warnings or errors occur,
instead of the default of only exiting with `1` on errors.

### `--file-path` <_path_>

```sh
cat readme.md | remark --file-path readme.md > doc/out.md
remark --file-path readme.md < readme.md > doc/out.md
```

Process the piped-in document as if it was a file at `path`.

### `--no-stdout`

```sh
remark --no-stdout
remark readme.md --no-stdout
```

Do not write a processed file to **stdout**(4).

### `--no-color`

```sh
remark --no-color
remark readme.md --no-color
```

Disable ANSI codes in output.

### `--no-rc`

```sh
remark --no-rc
remark readme.md --no-rc
```

Disables configuration from **remarkrc**(5) files. This does not apply to
Expand All @@ -196,7 +196,7 @@ explicitly provided files through `-c`, `--config-path`.
### `--no-ignore`

```sh
remark --no-ignore
remark . --no-ignore
```

Disables configuration from **remarkignore**(5) files. This does not apply to
Expand Down
34 changes: 17 additions & 17 deletions man/remark.1
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Otherwise, a fatal error is thrown.
.P
.RS 2
.nf
remark --config-path remarkrc.json
remark . --config-path remarkrc.json
.fi
.RE
.P
Expand All @@ -67,7 +67,7 @@ Specify configuration location. This loads an \fBremarkrc\fR(5) file which canno
.P
.RS 2
.nf
remark --ignore-path .gitignore
remark . --ignore-path .gitignore
.fi
.RE
.P
Expand All @@ -76,7 +76,7 @@ Specify ignore location. This loads an \fBremarkignore\fR(5) file which cannot b
.P
.RS 2
.nf
remark --setting \[dq]position:false\[dq]
remark readme.md --setting commonmark:true
.fi
.RE
.P
Expand All @@ -85,7 +85,7 @@ Specify settings (see \fBremarksetting\fR(7)). This must be a valid JSON object
.P
.RS 2
.nf
remark --use man
remark readme.md --use man
.fi
.RE
.P
Expand All @@ -94,7 +94,7 @@ Specify a plug-in to use, optionally with options. See \fBremarkplugin\fR(7) COM
.P
.RS 2
.nf
remark --ext doc
remark . --ext doc
.fi
.RE
.P
Expand All @@ -105,7 +105,7 @@ The given \fBextensions\fR can be comma or semi-colon separated.
.P
.RS 2
.nf
remark -w .
remark . -w
.fi
.RE
.P
Expand All @@ -127,7 +127,7 @@ The watch is stopped when \fBSIGINT\fR is received (usually done by pressing \fB
.P
.RS 2
.nf
remark --ast
remark readme.md --ast
.fi
.RE
.P
Expand All @@ -136,7 +136,7 @@ Instead of outputting document the internally used AST is exposed.
.P
.RS 2
.nf
remark --quiet
remark readme.md --quiet
.fi
.RE
.P
Expand All @@ -145,25 +145,25 @@ Do not output non-essential text, only warnings and errors.
.P
.RS 2
.nf
remark --silent
remark readme.md --silent
.fi
.RE
.P
Same as \fB-q\fR, \fB--quiet\fR, but also ignores warnings.
Do not output non-essential text or warning, only errors.
.SS "\fB-f\fR, \fB--frail\fR"
.P
.RS 2
.nf
remark --frail
remark readme.md --frail
.fi
.RE
.P
Exit with a status code of \fB1\fR if warnings are triggered for the processed code, instead of the default of only exiting with \fB1\fR on fatal errors.
Exit with a status code of \fB1\fR if warnings or errors occur, instead of the default of only exiting with \fB1\fR on errors.
.SS "\fB--file-path\fR <\fIpath\fR>"
.P
.RS 2
.nf
cat readme.md \[ba] remark --file-path readme.md > doc\[sl]out.md
remark --file-path readme.md < readme.md > doc\[sl]out.md
.fi
.RE
.P
Expand All @@ -172,7 +172,7 @@ Process the piped-in document as if it was a file at \fBpath\fR.
.P
.RS 2
.nf
remark --no-stdout
remark readme.md --no-stdout
.fi
.RE
.P
Expand All @@ -181,7 +181,7 @@ Do not write a processed file to \fBstdout\fR(4).
.P
.RS 2
.nf
remark --no-color
remark readme.md --no-color
.fi
.RE
.P
Expand All @@ -190,7 +190,7 @@ Disable ANSI codes in output.
.P
.RS 2
.nf
remark --no-rc
remark readme.md --no-rc
.fi
.RE
.P
Expand All @@ -199,7 +199,7 @@ Disables configuration from \fBremarkrc\fR(5) files. This does not apply to expl
.P
.RS 2
.nf
remark --no-ignore
remark . --no-ignore
.fi
.RE
.P
Expand Down

0 comments on commit fb0cbe8

Please sign in to comment.