Skip to content
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

Jump to bottom

Update USAGE.md #1463

Merged
merged 1 commit into from
Jan 30, 2024
Merged

Update USAGE.md #1463

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
9 changes: 8 additions & 1 deletion docs/USAGE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ Options:
[boolean] [default: true]
--markdown-toc-max-depth specifies the max depth of the table of contents in markdown output
[number] [default: 6]
--babel path to babelrc or babel.options.js to override
default babel config [string] [Standard: null]
--shallow shallow mode turns off dependency resolution, only
processing the specified files (or the main script
specified in package.json)
Expand All @@ -40,6 +42,9 @@ Options:
--no-package, --np dont find and use package.json for project-
configuration option defaults
[boolean] [default: false]
--external a string / glob match pattern that defines which
external modules will be whitelisted and included
in the generated documentation. [Standard: null]
--require-extension, --re additional extensions to include in require() and
import's search algorithm.For instance, adding .es5
would allow require("adder") to find "adder.es5"
Expand All @@ -58,8 +63,10 @@ Options:
[boolean] [default: false]
--sort-order The order to sort the documentation, may be
specified multiple times
[choices: "source", "alpha", "kind"]
[choices: "source", "alpha"]
[default: "source"]
--resolve Dependency resolution algorithm.
[choices: "browser", "node"] [Standard: "browser"]
--output, -o output location. omit for stdout, otherwise is a
filename for single-file outputs and a directory
name for multi-file outputs like html
Expand Down