{"id":15010500,"url":"https://github.com/nodejs/doc-kit","last_synced_at":"2025-10-19T22:30:44.141Z","repository":{"id":241882377,"uuid":"799332677","full_name":"nodejs/api-docs-tooling","owner":"nodejs","description":"Node.js's tooling for API generation","archived":false,"fork":false,"pushed_at":"2025-02-01T15:53:21.000Z","size":495,"stargazers_count":4,"open_issues_count":25,"forks_count":6,"subscribers_count":35,"default_branch":"main","last_synced_at":"2025-02-02T00:26:40.585Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://nodejs.org/api","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nodejs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-11T20:16:19.000Z","updated_at":"2025-01-27T22:03:04.000Z","dependencies_parsed_at":"2025-01-16T00:45:40.258Z","dependency_job_id":"0c33de80-387a-4926-8a20-8b74a4839112","html_url":"https://github.com/nodejs/api-docs-tooling","commit_stats":{"total_commits":110,"total_committers":10,"mean_commits":11.0,"dds":0.2909090909090909,"last_synced_commit":"7f2c125bae8ea16a5ade28c016b1497f2fd1f055"},"previous_names":["nodejs/api-docs-tooling"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodejs%2Fapi-docs-tooling","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodejs%2Fapi-docs-tooling/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodejs%2Fapi-docs-tooling/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodejs%2Fapi-docs-tooling/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nodejs","download_url":"https://codeload.github.com/nodejs/api-docs-tooling/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237221171,"owners_count":19274447,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ast","hast","mdast","node","unified","wip"],"created_at":"2024-09-24T19:34:31.270Z","updated_at":"2025-10-19T22:30:44.136Z","avatar_url":"https://github.com/nodejs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cbr /\u003e\n  \u003ca href=\"https://nodejs.org\"\u003e\n    \u003cpicture\u003e\n      \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://nodejs.org/static/logos/nodejsLight.svg\"\u003e\n      \u003cimg src=\"https://nodejs.org/static/logos/nodejsDark.svg\" width=\"200px\" alt=\"Node.js Logo\"\u003e\n    \u003c/picture\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ccode\u003e@nodejs/doc-kit\u003c/code\u003e is a tool to generate API documentation of Node.js. \u003ca href=\"https://github.com/nodejs/node/issues/52343\"\u003eSee this issue\u003c/a\u003e for more information.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca title=\"MIT License\" href=\"LICENSE\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/license-MIT-blue\" alt=\"MIT License\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://codecov.io/gh/nodejs/doc-kit\" \u003e\n    \u003cimg src=\"https://codecov.io/gh/nodejs/doc-kit/graph/badge.svg?token=TZRUKKDICU\" alt=\"Codecov coverage badge\"/\u003e\n  \u003c/a\u003e\n  \u003ca title=\"scorecard\" href=\"https://securityscorecards.dev/viewer/?uri=github.com/nodejs/doc-kit\"\u003e\n    \u003cimg src=\"https://api.securityscorecards.dev/projects/github.com/nodejs/doc-kit/badge\" alt=\"doc-kit scorecard badge\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.bestpractices.dev/projects/29\"\u003e\n    \u003cimg src=\"https://www.bestpractices.dev/projects/29/badge\" alt=\"CII Best Practices badge\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## Usage\n\nLocal invocation:\n\n```sh\n$ npx doc-kit --help\n```\n\n```sh\n$ node bin/cli.mjs --help\n```\n\n```\nUsage: @nodejs/doc-kit [options] [command]\n\nCLI tool to generate the Node.js API documentation\n\nOptions:\n  -h, --help          display help for command\n\nCommands:\n  generate [options]  Generate API docs\n  interactive         Launch guided CLI wizard\n  help [command]      display help for command\n```\n\n### `generate`\n\n```\nUsage: @nodejs/doc-kit generate [options]\n\nGenerate API docs\n\nOptions:\n  -i, --input \u003cpatterns...\u003e  Input file patterns (glob)\n  --ignore [patterns...]     Ignore patterns (comma-separated)\n  -o, --output \u003cdir\u003e         Output directory\n  -p, --threads \u003cnumber\u003e      (default: \"12\")\n  -v, --version \u003csemver\u003e     Target Node.js version (default: \"v22.14.0\")\n  -c, --changelog \u003curl\u003e      Changelog URL or path (default: \"https://raw.githubusercontent.com/nodejs/node/HEAD/CHANGELOG.md\")\n  --git-ref \u003curl\u003e            Git ref/commit URL (default: \"https://github.com/nodejs/node/tree/HEAD\")\n  -t, --target [modes...]    Target generator modes (choices: \"json-simple\", \"legacy-html\", \"legacy-html-all\", \"man-page\", \"legacy-json\", \"legacy-json-all\", \"addon-verify\", \"api-links\", \"orama-db\", \"llms-txt\")\n  -h, --help                 display help for command\n```\n\n### `interactive`\n\n```\nUsage: @nodejs/doc-kit interactive [options]\n\nLaunch guided CLI wizard\n\nOptions:\n  -h, --help  display help for command\n```\n\n## Examples\n\n### Legacy\n\nTo generate a 1:1 match with the [legacy tooling](https://github.com/nodejs/node/tree/main/tools/doc), use the `legacy-html`, `legacy-json`, `legacy-html-all`, and `legacy-json-all` generators.\n\n```sh\nnpx doc-kit generate \\\n  -t legacy-html \\\n  -t legacy-json \\\n  -i \"path/to/node/doc/api/*.md\" \\\n  -o out \\\n  --index path/to/node/doc/api/index.md\n```\n\n### Redesigned\n\nTo generate [our redesigned documentation pages](https://nodejs-api-docs-tooling.vercel.app), use the `web` and `orama-db` (for search) generators.\n\n```sh\nnpx doc-kit generate \\\n  -t web \\\n  -t orama-db \\\n  -i \"path/to/node/doc/api/*.md\" \\\n  -o out \\\n  --index path/to/node/doc/api/index.md\n```\n\n\u003e [!TIP]\n\u003e In order to use the search functionality, you _must_ serve the output directory.\n\u003e\n\u003e ```sh\n\u003e npx serve out\n\u003e ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnodejs%2Fdoc-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnodejs%2Fdoc-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnodejs%2Fdoc-kit/lists"}