Skip to content

fix: derive heading anchors from plain text, not rendered HTML #314

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
mtoy-googly-moogly merged 1 commit into from
May 13, 2026
Merged

fix: derive heading anchors from plain text, not rendered HTML #314

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
16 changes: 15 additions & 1 deletion scripts/render_document.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,20 @@ import {
import { DocumentPosition, DocumentRange, ModelDef } from "@malloydata/malloy";
import { DocsError } from "./errors.js";

function plainTextFromMarkdown(nodes: Markdown[]): string {
return nodes
.map((node) => {
if ("value" in node && typeof node.value === "string") {
return node.type === "html" ? "" : node.value;
}
if ("children" in node && Array.isArray(node.children)) {
return plainTextFromMarkdown(node.children as Markdown[]);
}
return "";
})
.join("");
}

/*
* A Renderer is capable of converting a parsed `Markdown` document into HTML,
* given that it exists at a given `path`.
Expand Down Expand Up @@ -202,7 +216,7 @@ class Renderer {
protected async heading(content: Markdown[], level: 1 | 2 | 3 | 4 | 5 | 6) {
const text = await this.children(content);
this.registerTitle(text, level);
const escapedText = hashForHeading(text);
const escapedText = hashForHeading(plainTextFromMarkdown(content));
this.hashes.push(escapedText);
// TODO handle ambiguous hashes?

Expand Down
Loading