From 8c009c3d2d582f4d288849656b918f96da746c88 Mon Sep 17 00:00:00 2001 From: Sujal Goel Date: Mon, 23 Mar 2026 03:37:38 +0530 Subject: [PATCH 1/2] feat(config): add doc-kit.config.mjs for webpack branding - Set repository to webpack/webpack (fixes GitHub links in navbar) - Set web.title to webpack (fixes product name in sidebar/navbar labels) - Disable jsx-ast editURL (generated docs have no hand-editable source) - Fix build-html script to auto-create out/ directory before generation Closes #6 --- doc-kit.config.mjs | 20 ++++++++++++++++++++ package.json | 2 +- 2 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 doc-kit.config.mjs diff --git a/doc-kit.config.mjs b/doc-kit.config.mjs new file mode 100644 index 0000000..8b2ece5 --- /dev/null +++ b/doc-kit.config.mjs @@ -0,0 +1,20 @@ +/** + * Configuration for @node-core/doc-kit when generating webpack API docs. + * + * @type {import('@node-core/doc-kit/src/utils/configuration/types').Configuration} + */ +export default { + global: { + // Point GitHub links to the webpack repository instead of nodejs/node + repository: 'webpack/webpack', + }, + web: { + // Use "webpack" as the product name in navbar and sidebar labels + title: 'webpack', + }, + 'jsx-ast': { + // Disable the "Edit this page" link — webpack API docs are generated from + // TypeScript types and don't have a corresponding hand-editable source file. + editURL: '', + }, +}; diff --git a/package.json b/package.json index 872e929..f26a733 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "scripts": { "generate-docs": "node generate-md.mjs", - "build-html": "doc-kit generate -t web -i ./pages/v5.x/**/*.md --type-map ./pages/v5.x/type-map.json -o out", + "build-html": "mkdir -p out && doc-kit generate -t web -i ./pages/v5.x/**/*.md --type-map ./pages/v5.x/type-map.json --config-file ./doc-kit.config.mjs -o out", "build": "npm run generate-docs && npm run build-html", "lint": "eslint .", "lint:fix": "eslint --fix .", From 1515f8973258c128d36468d79875763fa2168de5 Mon Sep 17 00:00:00 2001 From: Aviv Keller Date: Sun, 22 Mar 2026 18:25:18 -0400 Subject: [PATCH 2/2] Update package.json --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index f26a733..2d8dee6 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "scripts": { "generate-docs": "node generate-md.mjs", - "build-html": "mkdir -p out && doc-kit generate -t web -i ./pages/v5.x/**/*.md --type-map ./pages/v5.x/type-map.json --config-file ./doc-kit.config.mjs -o out", + "build-html": "doc-kit generate -t web -i ./pages/v5.x/**/*.md --type-map ./pages/v5.x/type-map.json --config-file ./doc-kit.config.mjs -o out", "build": "npm run generate-docs && npm run build-html", "lint": "eslint .", "lint:fix": "eslint --fix .",