Skip to main content

Introduction

Learn what webpack-doc-kit is and how it fits into the webpack ecosystem.

Quickstart

Get the documentation pipeline running locally in minutes.

How It Works

Understand the TypeDoc pipeline, custom plugins, and deployment flow.

Plugins

Explore the processor and custom theme plugins that power the output.

​
What is webpack-doc-kit?

webpack-doc-kit is an automated documentation pipeline that generates TypeScript API reference documentation for webpack. It reads webpack’s types.d.ts, processes it through TypeDoc with custom plugins, and produces Markdown and HTML output that is automatically deployed to GitHub Pages. The pipeline stays in sync with webpack automatically — a scheduled GitHub Actions workflow checks for new commits to webpack’s main branch every 24 hours and regenerates documentation when changes are detected.

​
Key features

TypeDoc extraction

Reads webpack’s types.d.ts and extracts all public TypeScript type definitions, interfaces, and classes.

Namespace merging

Custom processor plugin merges export= namespaces into their parents and converts accessors to properties for cleaner docs.

Stability annotations

The custom theme renders @deprecated, @experimental, @beta, and @legacy JSDoc tags as styled stability blockquotes.

Type map generation

Automatically generates a type-map.json linking every documented type to its HTML page URL — enabling cross-references.

Automated sync

A daily GitHub Actions workflow tracks webpack’s main branch HEAD and regenerates docs when new commits land.

GitHub Pages deployment

Built HTML output is automatically deployed to GitHub Pages on every push to main.

​
How the pipeline works

1

TypeDoc reads webpack types

generate-md.mjs bootstraps TypeDoc pointed at webpack/types.d.ts, using the custom doc-kit theme and typedoc-plugin-markdown.
2

Plugins process the output

The processor.mjs plugin merges namespaces and generates type-map.json. The custom theme plugin renders signatures, stability notes, and typed parameter lists.
3

Markdown is converted to HTML

@node-core/doc-kit converts the generated Markdown pages to HTML using the type-map.json for cross-reference links.
4

GitHub Pages receives the output

The deploy.yml workflow builds and uploads the out/ directory as a GitHub Pages artifact, then deploys it automatically.

npm scripts

All available npm run commands

GitHub Actions

CI, deploy, and sync workflows

Contributing

How to contribute changes

Build docs developers (and LLMs) love

Get started for freeTalk to us