Skip to content

fix(metadata): ensure YAML frontmatter is captured when preceding first heading #735

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 3 commits into from
Apr 2, 2026
+28 −2
Merged

fix(metadata): ensure YAML frontmatter is captured when preceding first heading #735

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
21e0ea7
fix(metadata): ensure YAML frontmatter is captured when preceding fir…
moshams272 Mar 30, 2026
2e18282
feat(metadata): add tests for capturing YAML frontmatter
moshams272 Mar 31, 2026
49815a6
test: remove redundant test
moshams272 Mar 31, 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
6 changes: 4 additions & 2 deletions src/generators/metadata/utils/parse.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,10 @@ export const parseApiDoc = ({ path, tree }, typeMap) => {
? tree.children.length
: tree.children.indexOf(nextHeadingNode);

// Create subtree for this section
const subTree = createTree('root', tree.children.slice(index, stop));
// Create subtree for this section. If it's the first entry, we start from the
// beginning of the tree to ensure top-level nodes (like YAML) are captured.
const startIndex = metadataCollection.length === 0 ? 0 : index;
const subTree = createTree('root', tree.children.slice(startIndex, stop));

visit(subTree, UNIST.isStabilityNode, node =>
visitStability(node, ignoreStability ? undefined : metadata)
Expand Down
Loading