Skip to content

Commit 6e74050

Browse files
committed
doc: Fix CLI examples
1 parent f66dd11 commit 6e74050

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,28 +55,28 @@ option for help:
5555
Usage:
5656

5757
# 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
5959

6060
# 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
6262

6363
# 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
6565

6666
# build and serve HTML docs for app.js
67-
bin/documentation.js serve app.js
67+
documentation serve app.js
6868

6969
# build, serve, and live-update HTML docs for app.js
70-
bin/documentation.js serve --watch app.js
70+
documentation serve --watch app.js
7171

7272
# validate JSDoc syntax in util.js
73-
bin/documentation.js lint util.js
73+
documentation lint util.js
7474

7575
# 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
7777

7878
# 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
8080

8181
Commands:
8282
serve [input..] generate, update, and display HTML documentation

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy