feat(theme): add doc-kit.config.mjs with webpack theming#18
Open
shivxmsharma wants to merge 3 commits intowebpack:mainfrom
Open
feat(theme): add doc-kit.config.mjs with webpack theming#18shivxmsharma wants to merge 3 commits intowebpack:mainfrom
shivxmsharma wants to merge 3 commits intowebpack:mainfrom
Conversation
alexander-akait
requested changes
Mar 13, 2026
avivkeller
approved these changes
Mar 13, 2026
Member
There was a problem hiding this comment.
Technically, this isn't part of the typedoc theme, rather, it's part of doc-kit.
For better organization, let's make a new root folder, say ui/ (or whatever name you want)
Contributor
Author
There was a problem hiding this comment.
Done — moved WebpackLogo.jsx to a new root-level ui/ folder and updated the path in doc-kit.config.mjs accordingly.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a
doc-kit.config.mjsconfiguration file to wire up webpack's branding and project-specific settings into the doc-kit web generator. Also adds aWebpackLogocomponent used by the NavBar.Three files are added/changed:
doc-kit.config.mjs(new) — setsglobal.repositorytowebpack/webpack(drives the GitHub icon link in the navbar),web.titletowebpack(page title), and remaps the#config/Logobundle alias to the new webpack logo component instead of the default Node.js logo.plugins/theme/ui/WebpackLogo.jsx(new) — a Preact component that renders the official webpack cube SVG (sourced from webpack/media) using the brand colors#8ed6fband#1c78c0. Accepts and forwards props so the NavBar can pass className, width, etc.package.json(modified) — adds--config-file ./doc-kit.config.mjsto thebuild-htmlscript so doc-kit loads the config on every build.Note: Local testing of
npm run build-htmlrequires Node.js v22+ due tofindPackageJSONusage inside@node-core/doc-kit. The build was not tested locally (running Node v20) but the config structure follows the doc-kit configuration API and will be validated by CI.What kind of change does this PR introduce?
feat
Did you add tests for your changes?
No. This is a configuration and branding change with no testable logic. Correctness is verified by the
build-htmlCI step.Does this PR introduce a breaking change?
No.
If relevant, what needs to be documented once your changes are merged or what have you already documented?
No documentation changes needed.
Use of AI
I used Claude to assist with drafting parts of the implementation. All code was reviewed and understood before committing. I have read the AI policy at https://github.com/webpack/governance/blob/main/AI_POLICY.md.