Skip to content

feat(config): add doc-kit.config.mjs for webpack branding #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
avivkeller merged 2 commits into from
Mar 22, 2026
Merged

feat(config): add doc-kit.config.mjs for webpack branding #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8c009c3
feat(config): add doc-kit.config.mjs for webpack branding
sujalgoel Mar 22, 2026
1515f89
Update package.json
avivkeller Mar 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions doc-kit.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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: '',
Comment on lines +16 to +18
Copy link
Member

@avivkeller avivkeller Mar 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO(me): if editURL is not supplied, don't show it on doc-kit

},
};
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 .",
Expand Down