feat(scripts): add scripts, packages, components, and config files#2
feat(scripts): add scripts, packages, components, and config files#2avivkeller merged 1 commit intomainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Sets up the repository’s initial build/tooling for generating a Doc Kit static site, including a prebuild step that generates a shared navigation/authors config consumed by custom theme components.
Changes:
- Add a config-generation script (
prebuild) that fetches nav/i18n/authors and derives sidebar + page author mappings frompages/. - Add Doc Kit configuration plus custom theme components (Navigation/Sidebar/Metabar) wired via
#theme/*imports. - Add baseline repo tooling/docs:
package.jsonscripts/deps, ESLint flat config, README/CONTRIBUTING.
Reviewed changes
Copilot reviewed 10 out of 11 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/generate-config.mjs | Generates components/config.json from remote JSON + local pages/ content. |
| scripts/constants.mjs | Centralizes paths and remote source URLs used by the generator. |
| package.json | Defines build/lint/format scripts and dependencies (including prebuild). |
| eslint.config.mjs | Adds ESLint flat config with TypeScript + MDX support. |
| doc-kit.config.mjs | Configures Doc Kit generators and maps #theme/* to local components. |
| components/Sidebar/index.jsx | Sidebar component consuming generated sideNav. |
| components/Navigation/index.jsx | Top navigation/search/theme toggle consuming generated topNav. |
| components/Metabar/index.jsx | Metabar/TOC + “Authors” + “Edit this page” consuming generated authors. |
| README.md | Documents repo purpose and local build workflow. |
| CONTRIBUTING.md | Documents content structure and contribution workflow. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
ovflowd
left a comment
There was a problem hiding this comment.
SGTM! Left tiny comments and the PR title should probably match that it adds the scripts and initial packages and components :)
|
adding Ref: https://github.com/nodejs/doc-kit/blob/main/.editorconfig |
|
Also I think we should create learn version of these configs; |
|
@canerakdas Yes, when I copied code from my demo, the |
Adds some logic to get this basically set up. cc @nodejs/web-admins for deployment previews