GitXplorerGitXplorer
n

api-docs-tooling

public
3 stars
4 forks
12 issues

Commits

List of commits on branch main.
Verified
bb4fc4100817f2d6185e7f64c18ae48436b1e2b9

meta: bump shiki from 1.16.2 to 1.17.7 (#99)

ddependabot[bot] committed 3 days ago
Verified
7c107947da6c742c3863a1155cd8bb35bb83a94d

meta: bump husky from 9.1.5 to 9.1.6 (#100)

ddependabot[bot] committed 3 days ago
Verified
80931dfd0ce4c173dbde8cb9a477ab17ffbe7867

meta: bump @types/node from 22.5.4 to 22.5.5 (#101)

ddependabot[bot] committed 3 days ago
Verified
06d722ff8c56f2a5f2f3874b52b188498d28d6a8

meta: bump step-security/harden-runner from 2.9.1 to 2.10.1 (#102)

ddependabot[bot] committed 3 days ago
Verified
054c7ab51a3c49b277acffa46d90a9f824e4bcb1

meta: bump github/codeql-action from 3.26.6 to 3.26.7 (#103)

ddependabot[bot] committed 3 days ago
Verified
3911d7c047d7e6d884c5aebd232f11b7e4e7227a

meta: bump yaml from 2.5.0 to 2.5.1 (#96)

ddependabot[bot] committed 10 days ago

README

The README file for this repository.


Node.js Logo

api-docs-tooling is a tool to generate API documentation of a Node.js project. See this issue for more information.

MIT License api-docs-tooling scorecard badge

Usage

Local invocation:

$ npx api-docs-tooling --help
Usage: api-docs-tooling [options]

CLI tool to generate API documentation of a Node.js project.

Options:
  -i, --input [patterns...]  Specify input file patterns using glob syntax
  -o, --output <path>        Specify the relative or absolute output directory
  -v, --version <semver>     Specify the target version of Node.js, semver compliant (default: "v22.6.0")
  -c, --changelog <url>      Specify the path (file: or https://) to the CHANGELOG.md file (default:
                             "https://raw.githubusercontent.com/nodejs/node/HEAD/CHANGELOG.md")
  -t, --target [mode...]     Set the processing target modes (choices: "json-simple", "legacy-html",
                             "legacy-html-all")
  -h, --help                 display help for command