Skip to content

Commit 5c3b6ba

Browse files
authored
docs(cli): Improve selection of examples that the CLI tool lists
1 parent 846ab94 commit 5c3b6ba

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

bin/documentation.js

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,28 @@ var argv = yargs
1515
.version(function () {
1616
return require('../package').version;
1717
})
18+
.usage('Usage:\n\n' +
19+
'# generate markdown docs for index.js and files it references\n' +
20+
'$0 build index.js -f md\n\n' +
21+
22+
'# generate html docs for all files in src\n' +
23+
'$0 build src/** -f html -o docs\n\n' +
24+
25+
'# document index.js, ignoring any files it requires or imports\n' +
26+
'$0 build index.js -f md --shallow\n\n' +
27+
28+
'# build, serve, and live-update html docs for app.js\n' +
29+
'$0 serve app.js\n\n' +
30+
31+
'# validate JSDoc syntax in util.js\n' +
32+
'$0 lint util.js\n\n' +
33+
34+
'# update the API section of README.md with docs from index.js\n' +
35+
'$0 readme index.js --section=API\n\n' +
36+
37+
'# build docs for all values exported by index.js\n' +
38+
'$0 build --document-exported index.js'
39+
)
1840
.recommendCommands()
1941
.help()
2042
.argv;

0 commit comments

Comments
 (0)