Interface: MarkdownHeadingEntry

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
depth	1 | 2 | 3 | 4 | 5 | 6	ATX heading depth: 1 (#) through 6 (######).
endLine	number	0-based line index of the last line in this section (inclusive).
startLine	number	0-based line index of the heading line itself.
text	string	The heading text with the leading # prefix stripped and trimmed.