mirror of
https://github.com/documentationjs/documentation.git
synced 2025-12-08 18:23:43 +00:00
810e08b6fd
BREAKING CHANGE: The serve parametr was remove, you can use any other tools which could be refresh and store your html site The private parameter has removed, use a access
44 lines
1.1 KiB
JavaScript
Executable File
44 lines
1.1 KiB
JavaScript
Executable File
#!/usr/bin/env node
|
|
|
|
/* eslint no-console: 0 */
|
|
|
|
import yargs from 'yargs';
|
|
import { hideBin } from 'yargs/helpers';
|
|
import commands from '../src/commands/index.js';
|
|
|
|
yargs(hideBin(process.argv))
|
|
.strict()
|
|
.command(commands.build)
|
|
.command(commands.lint)
|
|
.command(commands.readme)
|
|
.example('documentation build foo.js -f md > API.md')
|
|
.example('documentation readme index.js -s "API Docs" --github')
|
|
.version()
|
|
.usage(
|
|
`Usage:
|
|
|
|
# generate markdown docs for index.js and files it references
|
|
$0 build index.js -f md
|
|
|
|
# generate html docs for all files in src
|
|
$0 build src/** -f html -o docs
|
|
|
|
# document index.js, ignoring any files it requires or imports
|
|
$0 build index.js -f md --shallow
|
|
|
|
# build, serve, and live-update html docs for app.js
|
|
$0 serve app.js
|
|
|
|
# validate JSDoc syntax in util.js
|
|
$0 lint util.js
|
|
|
|
# update the API section of README.md with docs from index.js
|
|
$0 readme index.js --section=API
|
|
|
|
# build docs for all values exported by index.js
|
|
$0 build --document-exported index.js
|
|
`
|
|
)
|
|
.recommendCommands()
|
|
.help().argv;
|