@@ -55,28 +55,28 @@ option for help:
55
55
Usage:
56
56
57
57
# generate markdown docs for index.js and files it references
58
- bin/ documentation.js build index.js -f md
58
+ documentation build index.js -f md
59
59
60
60
# generate html docs for all files in src
61
- bin/ documentation.js build src/** -f html -o docs
61
+ documentation build src/** -f html -o docs
62
62
63
63
# document index.js, ignoring any files it requires or imports
64
- bin/ documentation.js build index.js -f md --shallow
64
+ documentation build index.js -f md --shallow
65
65
66
66
# build and serve HTML docs for app.js
67
- bin/ documentation.js serve app.js
67
+ documentation serve app.js
68
68
69
69
# build, serve, and live-update HTML docs for app.js
70
- bin/ documentation.js serve --watch app.js
70
+ documentation serve --watch app.js
71
71
72
72
# validate JSDoc syntax in util.js
73
- bin/ documentation.js lint util.js
73
+ documentation lint util.js
74
74
75
75
# update the API section of README.md with docs from index.js
76
- bin/ documentation.js readme index.js --section=API
76
+ documentation readme index.js --section=API
77
77
78
78
# build docs for all values exported by index.js
79
- bin/ documentation.js build --document-exported index.js
79
+ documentation build --document-exported index.js
80
80
81
81
Commands:
82
82
serve [input..] generate, update, and display HTML documentation
0 commit comments