Skip to content

fix: adapt TOC to body heading levels #2

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

Open
Restuta wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: adapt TOC to body heading levels #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
40 changes: 34 additions & 6 deletions src/core/markdown.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,8 +360,8 @@ export function buildHtmlDocument(input: {
border-radius: 1px;
transition: background 150ms ease;
}
.toc-lines span.depth-2 { width: 24px; }
.toc-lines span.depth-3 { width: 14px; }
.toc-lines span.depth-root { width: 24px; }
.toc-lines span.depth-child { width: 14px; }
.toc-lines span.active { background: var(--fg); }
.toc-nav {
position: absolute;
Expand Down Expand Up @@ -394,7 +394,7 @@ export function buildHtmlDocument(input: {
}
.toc-nav a:hover { color: var(--fg); background: var(--surface); }
.toc-nav a.active { color: var(--link); background: var(--surface); }
.toc-nav a.depth-3 { padding-left: 1.75rem; font-size: 0.8rem; }
.toc-nav a.depth-child { padding-left: 1.75rem; font-size: 0.8rem; }

/* Mobile adjustments */
@media (max-width: 600px) {
Expand Down Expand Up @@ -432,7 +432,31 @@ export function buildHtmlDocument(input: {
});
});
// TOC navigation — minimap lines + hover popover
const headings = document.querySelectorAll('article h2, article h3');
const pageTitle = ${JSON.stringify(input.title)};
Copy link

@vercel vercel bot Mar 24, 2026

Choose a reason for hiding this comment

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

XSS vulnerability in JSON.stringify usage within script tag allows attackers to inject arbitrary JavaScript via malicious document titles.

Fix on Vercel

const bodyHeadings = Array.from(
document.querySelectorAll('article h1, article h2, article h3, article h4'),
).filter((heading, index) => {
if (index !== 0) {
return true;
}

return !(
heading.tagName === 'H1' &&
(heading.textContent || '').trim() === pageTitle
);
});
const headingLevels = bodyHeadings.map((heading) => Number(heading.tagName.slice(1)));
const rootLevel =
headingLevels.length > 0 ? Math.min(...headingLevels) : null;
const childLevel =
rootLevel !== null && headingLevels.includes(rootLevel + 1)
? rootLevel + 1
: null;
const headings = bodyHeadings.filter((heading) => {
const level = Number(heading.tagName.slice(1));
return level === rootLevel || level === childLevel;
});

if (headings.length >= 3) {
headings.forEach((h, i) => { if (!h.id) h.id = 'h-' + i; });
const wrap = document.createElement('div');
Expand All @@ -444,15 +468,19 @@ export function buildHtmlDocument(input: {
const lineEls = [];
headings.forEach(h => {
const line = document.createElement('span');
const depth = h.tagName === 'H3' ? 'depth-3' : 'depth-2';
const depth =
childLevel !== null &&
Number(h.tagName.slice(1)) === childLevel
? 'depth-child'
: 'depth-root';
line.className = depth;
line.dataset.id = h.id;
lines.appendChild(line);
lineEls.push(line);
const a = document.createElement('a');
a.href = '#' + h.id;
a.textContent = h.textContent;
if (h.tagName === 'H3') a.classList.add('depth-3');
if (depth === 'depth-child') a.classList.add('depth-child');
a.addEventListener('click', e => {
e.preventDefault();
h.scrollIntoView({ behavior: 'auto', block: 'start' });
Expand Down
15 changes: 15 additions & 0 deletions tests/unit/markdown.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,21 @@ const answer = 42;
expect(html).toContain("text-underline-offset");
});

it("builds adaptive TOC logic for documents that use body h1 headings", () => {
const html = buildHtmlDocument({
title: "Doc Title",
description: "Example",
noindex: true,
bodyHtml:
"<h1>Doc Title</h1><h1>Section</h1><h2>Child</h2><h1>Another</h1>",
});

expect(html).toContain("article h1, article h2, article h3, article h4");
expect(html).toContain('const pageTitle = "Doc Title";');
expect(html).toContain("depth-root");
expect(html).toContain("depth-child");
});

it("renders real-world mixed markdown structures cleanly", async () => {
const rendered = await renderMarkdownToHtml(`
# Publish-It — Project Plan
Expand Down