Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation build pipeline to use @node-core/doc-kit v1.3.0 and migrates per-page metadata from HTML-comment YAML blocks to standard YAML frontmatter, aligning with the new doc-kit support and aiming to fix broken “active tab/section” behavior (Issue #6).
Changes:
- Bump
@node-core/doc-kitto1.3.0and addremark-frontmatterfor linting/parsing. - Replace HTML-comment “YAML” blocks with
---frontmatter across docs pages. - Remove the legacy prebuild/config-generation scripts and switch to a custom
#theme/Layoutoverride.
Reviewed changes
Copilot reviewed 74 out of 76 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/utils.mjs | Removed legacy markdown parsing and navigation/author utility helpers. |
| scripts/generate-component-config.mjs | Removed prebuild script that generated components/config.json (top nav/side nav/authors). |
| scripts/constants.mjs | Removed constants used by the deleted prebuild/config generation scripts. |
| pages/typescript/transpile.md | Convert authors metadata to YAML frontmatter. |
| pages/typescript/run.md | Convert authors metadata to YAML frontmatter. |
| pages/typescript/run-natively.md | Convert authors metadata to YAML frontmatter. |
| pages/typescript/publishing-a-ts-package.md | Convert authors metadata to YAML frontmatter. |
| pages/typescript/introduction.md | Convert authors metadata to YAML frontmatter. |
| pages/testing/using-test-runner.md | Convert authors metadata to YAML frontmatter. |
| pages/testing/mocking.md | Convert authors metadata to YAML frontmatter. |
| pages/testing/introduction.md | Convert authors metadata to YAML frontmatter. |
| pages/testing/collecting-code-coverage.md | Convert authors metadata to YAML frontmatter. |
| pages/security/security-best-practices.md | Convert authors metadata to YAML frontmatter. |
| pages/package-management/publishing-node-api-modules.md | Remove empty legacy YAML comment block. |
| pages/package-management/publishing-a-package.md | Convert authors metadata to YAML frontmatter. |
| pages/package-management/an-introduction-to-the-npm-package-manager.md | Convert authors metadata to YAML frontmatter. |
| pages/package-management/abi-stability.md | Remove empty legacy YAML comment block. |
| pages/index.md | Convert authors metadata to YAML frontmatter. |
| pages/http/websocket.md | Convert authors metadata to YAML frontmatter. |
| pages/http/fetch.md | Convert authors metadata to YAML frontmatter. |
| pages/http/enterprise-network-configuration.md | Convert authors metadata to YAML frontmatter. |
| pages/http/anatomy-of-an-http-transaction.md | Remove empty legacy YAML comment block. |
| pages/getting-started/userland-migrations.md | Convert authors metadata to YAML frontmatter. |
| pages/getting-started/the-v8-javascript-engine.md | Convert authors metadata to YAML frontmatter. |
| pages/getting-started/nodejs-with-webassembly.md | Convert authors metadata to YAML frontmatter. |
| pages/getting-started/nodejs-the-difference-between-development-and-production.md | Convert authors metadata to YAML frontmatter. |
| pages/getting-started/introduction-to-nodejs.md | Convert authors metadata to YAML frontmatter. |
| pages/getting-started/how-much-javascript-do-you-need-to-know-to-use-nodejs.md | Convert authors metadata to YAML frontmatter. |
| pages/getting-started/ecmascript-2015-es6-and-beyond.md | Convert authors metadata to YAML frontmatter. |
| pages/getting-started/differences-between-nodejs-and-the-browser.md | Convert authors metadata to YAML frontmatter. |
| pages/file-system/writing-files-with-nodejs.md | Convert authors metadata to YAML frontmatter. |
| pages/file-system/working-with-folders-in-nodejs.md | Convert authors metadata to YAML frontmatter. |
| pages/file-system/working-with-file-descriptors-in-nodejs.md | Convert authors metadata to YAML frontmatter. |
| pages/file-system/working-with-different-filesystems.md | Remove empty legacy YAML comment block. |
| pages/file-system/reading-files-with-nodejs.md | Convert authors metadata to YAML frontmatter. |
| pages/file-system/nodejs-file-stats.md | Convert authors metadata to YAML frontmatter. |
| pages/file-system/nodejs-file-paths.md | Convert authors metadata to YAML frontmatter. |
| pages/diagnostics/user-journey.md | Remove empty legacy YAML comment block. |
| pages/diagnostics/profiling.md | Remove empty legacy YAML comment block. |
| pages/diagnostics/poor-performance/using-linux-perf.md | Remove empty legacy YAML comment block. |
| pages/diagnostics/poor-performance/index.md | Remove empty legacy YAML comment block. |
| pages/diagnostics/memory/using-heap-snapshot.md | Remove empty legacy YAML comment block. |
| pages/diagnostics/memory/using-heap-profiler.md | Remove empty legacy YAML comment block. |
| pages/diagnostics/memory/using-gc-traces.md | Remove empty legacy YAML comment block. |
| pages/diagnostics/memory/understanding-and-tuning-memory.md | Convert authors metadata to YAML frontmatter. |
| pages/diagnostics/memory/index.md | Remove empty legacy YAML comment block. |
| pages/diagnostics/live-debugging/using-inspector.md | Remove empty legacy YAML comment block. |
| pages/diagnostics/live-debugging/index.md | Remove empty legacy YAML comment block. |
| pages/diagnostics/flame-graphs.md | Remove empty legacy YAML comment block. |
| pages/diagnostics/debugging.md | Remove empty legacy YAML comment block. |
| pages/command-line/run-nodejs-scripts-from-the-command-line.md | Convert authors metadata to YAML frontmatter. |
| pages/command-line/output-to-the-command-line-using-nodejs.md | Convert authors metadata to YAML frontmatter. |
| pages/command-line/how-to-use-the-nodejs-repl.md | Convert authors metadata to YAML frontmatter. |
| pages/command-line/how-to-read-environment-variables-from-nodejs.md | Convert authors metadata to YAML frontmatter. |
| pages/command-line/accept-input-from-the-command-line-in-nodejs.md | Convert authors metadata to YAML frontmatter. |
| pages/asynchronous-work/understanding-setimmediate.md | Convert authors metadata to YAML frontmatter. |
| pages/asynchronous-work/understanding-processnexttick.md | Convert authors metadata to YAML frontmatter. |
| pages/asynchronous-work/the-nodejs-event-emitter.md | Convert authors metadata to YAML frontmatter. |
| pages/asynchronous-work/overview-of-blocking-vs-non-blocking.md | Convert authors metadata to YAML frontmatter. |
| pages/asynchronous-work/javascript-asynchronous-programming-and-callbacks.md | Convert authors metadata to YAML frontmatter. |
| pages/asynchronous-work/how-to-use-streams.md | Convert authors metadata to YAML frontmatter. |
| pages/asynchronous-work/event-loop-timers-and-nexttick.md | Remove empty legacy YAML comment block. |
| pages/asynchronous-work/dont-block-the-event-loop.md | Remove empty legacy YAML comment block. |
| pages/asynchronous-work/discover-promises-in-nodejs.md | Convert authors metadata to YAML frontmatter. |
| pages/asynchronous-work/discover-javascript-timers.md | Convert authors metadata to YAML frontmatter. |
| pages/asynchronous-work/backpressuring-in-streams.md | Remove empty legacy YAML comment block. |
| pages/asynchronous-work/asynchronous-flow-control.md | Convert authors metadata to YAML frontmatter. |
| package.json | Bump doc-kit to 1.3.0, add remark-frontmatter, remove prebuild hook. |
| package-lock.json | Lockfile updates for doc-kit 1.3.0 and new remark-frontmatter dependency tree. |
| doc-kit.config.mjs | Move pageURL/editURL under web, and override #theme/Layout only. |
| components/Sidebar/index.jsx | Removed custom sidebar that depended on generated components/config.json. |
| components/Navigation/index.jsx | Stop reading generated nav config; nav items now empty. |
| components/Metabar/index.jsx | Derive authors/edit link from doc-kit metadata + #theme/config editURL. |
| components/Layout/index.jsx | New custom layout composing doc-kit sidebar/footer with local nav/metabar. |
| .remarkrc.json | Add remark-frontmatter plugin before @node-core/remark-lint. |
| .gitignore | Stop ignoring components/config.json (file no longer generated/used). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
flakey5
approved these changes
Apr 2, 2026
ovflowd
approved these changes
Apr 2, 2026
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
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.
Fixes: #6
Fixes: #5
Also replaces YAML with frontmatter, as this doc-kit version now supports that.