File tree Expand file tree Collapse file tree 1 file changed +22
-0
lines changed Expand file tree Collapse file tree 1 file changed +22
-0
lines changed Original file line number Diff line number Diff line change @@ -15,6 +15,28 @@ var argv = yargs
15
15
. version ( function ( ) {
16
16
return require ( '../package' ) . version ;
17
17
} )
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
+ )
18
40
. recommendCommands ( )
19
41
. help ( )
20
42
. argv ;
You can’t perform that action at this time.
0 commit comments