|
1 | 1 | import { docsMarkdownExtensions } from '@tanstack/markdown/extensions/docs' |
2 | 2 | import { parseMarkdown } from '@tanstack/markdown/parser' |
3 | | -import type { MarkdownDocument, MarkdownHeading } from '@tanstack/markdown' |
| 3 | +import type { |
| 4 | + BlockNode, |
| 5 | + InlineNode, |
| 6 | + MarkdownDocument, |
| 7 | + MarkdownHeading, |
| 8 | +} from '@tanstack/markdown' |
4 | 9 |
|
5 | 10 | export type { MarkdownDocument, MarkdownHeading } from '@tanstack/markdown' |
6 | 11 |
|
7 | 12 | export type SiteMarkdownDocument = MarkdownDocument & { |
8 | 13 | headings: Array<MarkdownHeading> |
9 | 14 | } |
10 | 15 |
|
| 16 | +const escapedLessThanToken = '\uE000' |
| 17 | +const escapedGreaterThanToken = '\uE001' |
| 18 | + |
11 | 19 | export function parseSiteMarkdown(content: string): SiteMarkdownDocument { |
12 | | - const document = parseMarkdown(content, { |
| 20 | + const headingSlugger = createHeadingSlugger() |
| 21 | + const document = parseMarkdown(protectEscapedAngleBrackets(content), { |
13 | 22 | allowHtml: true, |
14 | 23 | extensions: docsMarkdownExtensions(), |
15 | | - headingIds: true, |
| 24 | + headingIds: (text) => |
| 25 | + headingSlugger(restoreEscapedAngleBracketText(text).replace(/[<>]/g, '')), |
16 | 26 | }) |
17 | 27 |
|
| 28 | + restoreEscapedAngleBrackets(document) |
| 29 | + |
18 | 30 | return { |
19 | 31 | ...document, |
20 | | - headings: document.headings ?? [], |
| 32 | + headings: collectHeadings(document), |
| 33 | + } |
| 34 | +} |
| 35 | + |
| 36 | +function protectEscapedAngleBrackets(content: string) { |
| 37 | + const lines = content.split('\n') |
| 38 | + const protectedLines: Array<string> = [] |
| 39 | + let fence: { marker: '`' | '~'; size: number } | undefined |
| 40 | + |
| 41 | + for (const line of lines) { |
| 42 | + const fenceMatch = line.match(/^ {0,3}(`{3,}|~{3,})/) |
| 43 | + |
| 44 | + if (fence) { |
| 45 | + protectedLines.push(line) |
| 46 | + |
| 47 | + if ( |
| 48 | + fenceMatch && |
| 49 | + fenceMatch[1]?.startsWith(fence.marker.repeat(fence.size)) |
| 50 | + ) { |
| 51 | + fence = undefined |
| 52 | + } |
| 53 | + |
| 54 | + continue |
| 55 | + } |
| 56 | + |
| 57 | + if (fenceMatch) { |
| 58 | + const marker = fenceMatch[1]?.[0] |
| 59 | + |
| 60 | + if (marker === '`' || marker === '~') { |
| 61 | + fence = { |
| 62 | + marker, |
| 63 | + size: fenceMatch[1]?.length ?? 3, |
| 64 | + } |
| 65 | + } |
| 66 | + |
| 67 | + protectedLines.push(line) |
| 68 | + continue |
| 69 | + } |
| 70 | + |
| 71 | + protectedLines.push(protectEscapedAngleBracketsInLine(line)) |
| 72 | + } |
| 73 | + |
| 74 | + return protectedLines.join('\n') |
| 75 | +} |
| 76 | + |
| 77 | +function protectEscapedAngleBracketsInLine(line: string) { |
| 78 | + let result = '' |
| 79 | + let index = 0 |
| 80 | + let inlineCodeFenceSize = 0 |
| 81 | + |
| 82 | + while (index < line.length) { |
| 83 | + const character = line[index] |
| 84 | + |
| 85 | + if (character === '`') { |
| 86 | + const fenceSize = countRun(line, index, '`') |
| 87 | + const fence = '`'.repeat(fenceSize) |
| 88 | + result += fence |
| 89 | + index += fenceSize |
| 90 | + |
| 91 | + if (inlineCodeFenceSize === 0) { |
| 92 | + inlineCodeFenceSize = fenceSize |
| 93 | + } else if (inlineCodeFenceSize === fenceSize) { |
| 94 | + inlineCodeFenceSize = 0 |
| 95 | + } |
| 96 | + |
| 97 | + continue |
| 98 | + } |
| 99 | + |
| 100 | + if (inlineCodeFenceSize === 0 && character === '\\') { |
| 101 | + const nextCharacter = line[index + 1] |
| 102 | + |
| 103 | + if (nextCharacter === '<') { |
| 104 | + result += escapedLessThanToken |
| 105 | + index += 2 |
| 106 | + continue |
| 107 | + } |
| 108 | + |
| 109 | + if (nextCharacter === '>') { |
| 110 | + result += escapedGreaterThanToken |
| 111 | + index += 2 |
| 112 | + continue |
| 113 | + } |
| 114 | + } |
| 115 | + |
| 116 | + result += character |
| 117 | + index++ |
| 118 | + } |
| 119 | + |
| 120 | + return result |
| 121 | +} |
| 122 | + |
| 123 | +function countRun(value: string, start: number, character: string) { |
| 124 | + let index = start |
| 125 | + |
| 126 | + while (value[index] === character) { |
| 127 | + index++ |
| 128 | + } |
| 129 | + |
| 130 | + return index - start |
| 131 | +} |
| 132 | + |
| 133 | +function restoreEscapedAngleBrackets(document: MarkdownDocument) { |
| 134 | + for (const child of document.children) { |
| 135 | + restoreEscapedAngleBracketsInBlock(child) |
| 136 | + } |
| 137 | +} |
| 138 | + |
| 139 | +function restoreEscapedAngleBracketsInBlock(block: BlockNode) { |
| 140 | + switch (block.type) { |
| 141 | + case 'heading': |
| 142 | + case 'paragraph': |
| 143 | + restoreEscapedAngleBracketsInInlineNodes(block.children) |
| 144 | + return |
| 145 | + case 'blockquote': |
| 146 | + case 'callout': |
| 147 | + case 'component': |
| 148 | + for (const child of block.children) { |
| 149 | + restoreEscapedAngleBracketsInBlock(child) |
| 150 | + } |
| 151 | + return |
| 152 | + case 'list': |
| 153 | + for (const item of block.items) { |
| 154 | + for (const child of item.children) { |
| 155 | + restoreEscapedAngleBracketsInBlock(child) |
| 156 | + } |
| 157 | + } |
| 158 | + return |
| 159 | + case 'table': |
| 160 | + for (const cell of [...block.header, ...block.rows.flat()]) { |
| 161 | + restoreEscapedAngleBracketsInInlineNodes(cell.children) |
| 162 | + } |
| 163 | + return |
| 164 | + case 'code': |
| 165 | + case 'html': |
| 166 | + case 'thematicBreak': |
| 167 | + return |
| 168 | + } |
| 169 | +} |
| 170 | + |
| 171 | +function restoreEscapedAngleBracketsInInlineNodes(nodes: Array<InlineNode>) { |
| 172 | + for (const node of nodes) { |
| 173 | + switch (node.type) { |
| 174 | + case 'text': |
| 175 | + node.value = restoreEscapedAngleBracketText(node.value) |
| 176 | + break |
| 177 | + case 'strong': |
| 178 | + case 'emphasis': |
| 179 | + case 'strike': |
| 180 | + case 'link': |
| 181 | + restoreEscapedAngleBracketsInInlineNodes(node.children) |
| 182 | + break |
| 183 | + case 'inlineCode': |
| 184 | + case 'image': |
| 185 | + case 'break': |
| 186 | + case 'inlineHtml': |
| 187 | + break |
| 188 | + } |
| 189 | + } |
| 190 | +} |
| 191 | + |
| 192 | +function restoreEscapedAngleBracketText(value: string) { |
| 193 | + return value |
| 194 | + .replaceAll(escapedLessThanToken, '<') |
| 195 | + .replaceAll(escapedGreaterThanToken, '>') |
| 196 | +} |
| 197 | + |
| 198 | +function collectHeadings(document: MarkdownDocument): Array<MarkdownHeading> { |
| 199 | + const headings: Array<MarkdownHeading> = [] |
| 200 | + |
| 201 | + collectHeadingsFromBlocks(document.children, headings, undefined, false) |
| 202 | + |
| 203 | + return headings |
| 204 | +} |
| 205 | + |
| 206 | +function collectHeadingsFromBlocks( |
| 207 | + blocks: Array<BlockNode>, |
| 208 | + headings: Array<MarkdownHeading>, |
| 209 | + framework: string | undefined, |
| 210 | + insideSkippedComponent: boolean, |
| 211 | +) { |
| 212 | + for (const block of blocks) { |
| 213 | + switch (block.type) { |
| 214 | + case 'heading': { |
| 215 | + if (!insideSkippedComponent && block.id) { |
| 216 | + const heading: MarkdownHeading = { |
| 217 | + id: block.id, |
| 218 | + text: inlineText(block.children), |
| 219 | + level: block.depth, |
| 220 | + } |
| 221 | + const headingFramework = block.framework ?? framework |
| 222 | + |
| 223 | + if (headingFramework) { |
| 224 | + heading.framework = headingFramework |
| 225 | + } |
| 226 | + |
| 227 | + headings.push(heading) |
| 228 | + } |
| 229 | + |
| 230 | + break |
| 231 | + } |
| 232 | + case 'list': |
| 233 | + for (const item of block.items) { |
| 234 | + collectHeadingsFromBlocks( |
| 235 | + item.children, |
| 236 | + headings, |
| 237 | + framework, |
| 238 | + insideSkippedComponent, |
| 239 | + ) |
| 240 | + } |
| 241 | + break |
| 242 | + case 'blockquote': |
| 243 | + case 'callout': |
| 244 | + collectHeadingsFromBlocks( |
| 245 | + block.children, |
| 246 | + headings, |
| 247 | + framework, |
| 248 | + insideSkippedComponent, |
| 249 | + ) |
| 250 | + break |
| 251 | + case 'component': { |
| 252 | + const componentName = block.name.toLowerCase() |
| 253 | + const nextInsideSkippedComponent = |
| 254 | + insideSkippedComponent || componentName === 'tabs' |
| 255 | + const nextFramework = |
| 256 | + block.tagName === 'md-framework-panel' |
| 257 | + ? (block.properties?.['data-framework'] ?? framework) |
| 258 | + : framework |
| 259 | + |
| 260 | + collectHeadingsFromBlocks( |
| 261 | + block.children, |
| 262 | + headings, |
| 263 | + nextFramework, |
| 264 | + nextInsideSkippedComponent, |
| 265 | + ) |
| 266 | + break |
| 267 | + } |
| 268 | + case 'paragraph': |
| 269 | + case 'code': |
| 270 | + case 'table': |
| 271 | + case 'html': |
| 272 | + case 'thematicBreak': |
| 273 | + break |
| 274 | + } |
| 275 | + } |
| 276 | +} |
| 277 | + |
| 278 | +function inlineText(nodes: Array<InlineNode>): string { |
| 279 | + let text = '' |
| 280 | + |
| 281 | + for (const node of nodes) { |
| 282 | + switch (node.type) { |
| 283 | + case 'text': |
| 284 | + case 'inlineCode': |
| 285 | + text += node.value |
| 286 | + break |
| 287 | + case 'strong': |
| 288 | + case 'emphasis': |
| 289 | + case 'strike': |
| 290 | + case 'link': |
| 291 | + text += inlineText(node.children) |
| 292 | + break |
| 293 | + case 'image': |
| 294 | + text += node.alt |
| 295 | + break |
| 296 | + case 'break': |
| 297 | + case 'inlineHtml': |
| 298 | + break |
| 299 | + } |
| 300 | + } |
| 301 | + |
| 302 | + return text |
| 303 | +} |
| 304 | + |
| 305 | +function createHeadingSlugger() { |
| 306 | + const seen = new Map<string, number>() |
| 307 | + |
| 308 | + return (value: string) => { |
| 309 | + const base = |
| 310 | + value |
| 311 | + .toLowerCase() |
| 312 | + .normalize('NFKD') |
| 313 | + .replace(/[\u0300-\u036f]/g, '') |
| 314 | + .replace(/&[a-z0-9#]+;/gi, '') |
| 315 | + .replace(/[^a-z0-9]+/g, '-') |
| 316 | + .replace(/^-+|-+$/g, '') || 'section' |
| 317 | + const count = seen.get(base) ?? 0 |
| 318 | + |
| 319 | + seen.set(base, count + 1) |
| 320 | + |
| 321 | + return count === 0 ? base : `${base}-${count + 1}` |
21 | 322 | } |
22 | 323 | } |
0 commit comments