Skip to content

Commit f9f9a36

Browse files
committed
Add docs for fileglob support in remark(1)
Closes GH-120.
1 parent fa1f0c1 commit f9f9a36

File tree

4 files changed

+11
-4
lines changed

4 files changed

+11
-4
lines changed

doc/remark.1.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,17 @@
22

33
## SYNOPSIS
44

5-
`remark` \[`options`] <_file|dir_ _..._>
5+
`remark` \[`options`] <_pathspec_...>
66

77
## DESCRIPTION
88

99
**remark** is a markdown processor powered by plugins.
1010

11+
<_pathspec_...> refers to files to process. Fileglobs (e.g., `*.md`)
12+
can be given to add all matching files. Directories can be given (e.g. `dir`
13+
to add `dir/readme.md` and `dir/sub/history.mkd`) to add files with a known
14+
markdown extension (see the `-e`, `--ext` flag).
15+
1116
Logs verbose debugging information when `$DEBUG` is set to `"*"`.
1217

1318
## OPTIONS

lib/cli/cli.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ function help() {
229229
var program = new Command(pack.name)
230230
.version(pack.version)
231231
.description(pack.description)
232-
.usage('[options] <file|dir ...>')
232+
.usage('[options] <pathspec...>')
233233
.option('-o, --output [path]', 'specify output location')
234234
.option('-c, --config-path <path>', 'specify configuration location')
235235
.option('-i, --ignore-path <path>', 'specify ignore location')

man/remark.1

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,13 @@
33
\fBremark\fR - Markdown processor
44
.SH "SYNOPSIS"
55
.P
6-
\fBremark\fR \[lB]\fBoptions\fR\[rB] <\fIfile\[ba]dir\fR \fI...\fR>
6+
\fBremark\fR \[lB]\fBoptions\fR\[rB] <\fIpathspec\fR...>
77
.SH "DESCRIPTION"
88
.P
99
\fBremark\fR is a markdown processor powered by plugins.
1010
.P
11+
<\fIpathspec\fR...> refers to files to process. Fileglobs (e.g., \fB*.md\fR) can be given to add all matching files. Directories can be given (e.g. \fBdir\fR to add \fBdir\[sl]readme.md\fR and \fBdir\[sl]sub\[sl]history.mkd\fR) to add files with a known markdown extension (see the \fB-e\fR, \fB--ext\fR flag).
12+
.P
1113
Logs verbose debugging information when \fB\[Do]DEBUG\fR is set to \fB\[dq]*\[dq]\fR.
1214
.SH "OPTIONS"
1315
.SS "\fB-h\fR, \fB--help\fR"

readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ npm install --global remark
180180
Use:
181181

182182
```text
183-
Usage: remark [options] <file|dir ...>
183+
Usage: remark [options] <pathspec...>
184184
185185
Markdown processor powered by plugins
186186

0 commit comments

Comments
 (0)