Skip to content

Add more usage examples. Fixes #526 #605

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 1, 2016
Merged

Add more usage examples. Fixes #526 #605

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions bin/documentation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,28 @@ var argv = yargs
.version(function () {
return require('../package').version;
})
.usage('Usage:\n\n' +
'# generate markdown docs for index.js and files it references\n' +
'$0 build index.js -f md\n\n' +

'# generate html docs for all files in src\n' +
'$0 build src/** -f html -o docs\n\n' +

'# document index.js, ignoring any files it requires or imports\n' +
'$0 build index.js -f md --shallow\n\n' +

'# build, serve, and live-update html docs for app.js\n' +
'$0 serve app.js\n\n' +

'# validate JSDoc syntax in util.js\n' +
'$0 lint util.js\n\n' +

'# update the API section of README.md with docs from index.js\n' +
'$0 readme index.js --section=API\n\n' +

'# build docs for all values exported by index.js\n' +
'$0 build --document-exported index.js'
)
.recommendCommands()
.help()
.argv;
Expand Down