codevise/documentation.js
Generate JSDoc with documentation-js
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| input | Input directory or files. | yes | — |
| output | A filename for single-file outputs and a directory name for multi-file outputs like html. | yes | — |
| theme | This must be a valid theme module. | — | — |
| themePackage | Package name/url that will be passed to npm to install the theme. | — | — |
| projectName | The project name. | — | — |
| projectVersion | The project version. | — | — |
| projectDescription | The project description. | — | — |
| projectHomepage | The project homepage. | — | — |
| favicon | Favicon used in html. | — | — |
| markdownToc | Include a table of contents in markdown output. | — | — |
| markdownTocMaxDepth | Specifies the max depth of the table of contents in markdown output. | — | — |
| shallow | Shallow mode turns off dependency resolution, only processing the specified files (or the main script specified in package.json). | — | — |
| config | Path of file defining the TOC. | — | — |
| noPackage | Do not find and use package.json for project configuration option defaults. | — | — |
| external | Glob match pattern that defines which external modules will be included in the generated documentation. | — | — |
| requireExtension | Additional extensions to include in `require()` and `import` search algorithm. For instance, adding `.es5` would allow `require("adder")` to find `adder.es5`. | — | — |
| parseExtension | Additional extensions to parse as source code. | — | — |
| private | Generate documentation tagged as private. | — | — |
| access | Include only comments with a given access level, out of private, protected, public, undefined. By default, public, protected, and undefined access levels are included. | — | — |
| github | Unfer links to github in documentation. | — | — |
| inferPrivate | Infer private access based on the name. This is a regular expression that is used to match the name. | — | — |
| documentExported | Generate documentation for all exported bindings and members even if there is no JSDoc for them. | — | — |
| sortOrder | The order to sort the documentation: `source` or `alpha`. | — | — |
| format | `html`, `json`, `md` or `remark`. | — | html |
Outputs
no outputs