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..2d8dee6 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": "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 .",