Interface: MarkdownHeadingEntry
Defined in: lib/classes/spooled_markdown_artifact.ts:25
A single heading entry in the document's structural index.
Remarks
startLine is the 0-based line of the heading itself. endLine is the 0-based index of the last line belonging to this section (inclusive) — the line immediately before the next heading of equal or lesser depth, or the last line of the document.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
depth | 1 | 2 | 3 | 4 | 5 | 6 | ATX heading depth: 1 (#) through 6 (######). | lib/classes/spooled_markdown_artifact.ts:27 |
endLine | number | 0-based line index of the last line in this section (inclusive). | lib/classes/spooled_markdown_artifact.ts:33 |
startLine | number | 0-based line index of the heading line itself. | lib/classes/spooled_markdown_artifact.ts:31 |
text | string | The heading text with the leading # prefix stripped and trimmed. | lib/classes/spooled_markdown_artifact.ts:29 |