{"id":47712914,"url":"https://github.com/webpack/webpack-doc-kit","last_synced_at":"2026-04-02T18:41:32.764Z","repository":{"id":343614246,"uuid":"1178427422","full_name":"webpack/webpack-doc-kit","owner":"webpack","description":null,"archived":false,"fork":false,"pushed_at":"2026-03-30T15:50:15.000Z","size":305,"stargazers_count":12,"open_issues_count":6,"forks_count":53,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-03-30T17:39:12.760Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/webpack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"open_collective":"webpack"}},"created_at":"2026-03-11T02:29:26.000Z","updated_at":"2026-03-30T15:50:34.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/webpack/webpack-doc-kit","commit_stats":null,"previous_names":["avivkeller/webpack-doc-kit","webpack/webpack-doc-kit"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/webpack/webpack-doc-kit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webpack%2Fwebpack-doc-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webpack%2Fwebpack-doc-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webpack%2Fwebpack-doc-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webpack%2Fwebpack-doc-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webpack","download_url":"https://codeload.github.com/webpack/webpack-doc-kit/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webpack%2Fwebpack-doc-kit/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31313182,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-02T12:59:32.332Z","status":"ssl_error","status_checked_at":"2026-04-02T12:54:48.875Z","response_time":89,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2026-04-02T18:41:32.194Z","updated_at":"2026-04-02T18:41:32.759Z","avatar_url":"https://github.com/webpack.png","language":"JavaScript","readme":"# webpack-doc-kit\n\nAutomated TypeScript API documentation generator for [webpack](https://github.com/webpack/webpack). Extracts type definitions from webpack's `types.d.ts` and produces Markdown and HTML documentation, deployed to GitHub Pages.\n\n## How It Works\n\n1. **TypeDoc** reads webpack's TypeScript type definitions\n2. Custom plugins process the output (namespace merging, type mapping, themed rendering)\n3. **@node-core/doc-kit** converts Markdown to HTML\n4. GitHub Actions deploys the result to GitHub Pages\n\n### Webpack Version Tracking\n\nThe `HEAD_COMMIT` file pins the exact webpack/webpack commit used for doc generation. A scheduled GitHub Action runs every 24 hours to:\n\n1. Fetch the latest webpack `main` branch HEAD\n2. Update `HEAD_COMMIT`\n3. Regenerate documentation\n4. Push the changes to this repository\n\nThis ensures documentation stays in sync with upstream webpack without manual intervention.\n\n## Project Structure\n\n```\n├── generate-md.mjs          # TypeDoc entry point\n├── plugins/\n│   ├── processor.mjs         # Namespace merging + type-map generation\n│   └── theme/                # Custom doc-kit theme\n├── HEAD_COMMIT               # Pinned webpack commit SHA\n├── .github/workflows/\n│   ├── ci.yml                # Lint + doc generation check\n│   ├── deploy.yml            # Build HTML + deploy to GitHub Pages\n│   └── sync.yml              # Daily webpack sync\n└── package.json\n```\n\n## Scripts\n\n| Script                  | Description                          |\n| ----------------------- | ------------------------------------ |\n| `npm run clone-webpack` | Clone webpack repo at pinned commit  |\n| `npm run generate-docs` | Generate Markdown from webpack types |\n| `npm run build-html`    | Convert Markdown to HTML             |\n| `npm run build`         | Generate docs + build HTML           |\n| `npm run lint`          | Run ESLint                           |\n| `npm run format:check`  | Check Prettier formatting            |\n\n## Contributing\n\nWhen making changes to documentation generation (plugins, `generate-md.mjs`, `tsconfig.json`), ensure the docs can still be generated successfully. CI will verify this on every pull request.\n\n## License\n\nSee the [webpack project](https://github.com/webpack/webpack) for license details.\n","funding_links":["https://opencollective.com/webpack"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebpack%2Fwebpack-doc-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebpack%2Fwebpack-doc-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebpack%2Fwebpack-doc-kit/lists"}