---
url: >-
  https://adk.nht.io/api/@nhtio/adk/spooled_artifact/interfaces/MarkdownHeadingEntry.md
description: A single heading entry in the document's structural index.
---

# Interface: MarkdownHeadingEntry

Defined in: [lib/classes/spooled\_markdown\_artifact.ts:25](https://github.com/NHTIO/ADK/blob/v1.20260605.0/src/lib/classes/spooled_markdown_artifact.ts#L25)

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](https://github.com/NHTIO/ADK/blob/v1.20260605.0/src/lib/classes/spooled_markdown_artifact.ts#L27) |
|  `endLine`     | `number`                               | 0-based line index of the last line in this section (inclusive).   | [lib/classes/spooled\_markdown\_artifact.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260605.0/src/lib/classes/spooled_markdown_artifact.ts#L33) |
|  `startLine` | `number`                               | 0-based line index of the heading line itself.                     | [lib/classes/spooled\_markdown\_artifact.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260605.0/src/lib/classes/spooled_markdown_artifact.ts#L31) |
|  `text`           | `string`                               | The heading text with the leading `#` prefix stripped and trimmed. | [lib/classes/spooled\_markdown\_artifact.ts:29](https://github.com/NHTIO/ADK/blob/v1.20260605.0/src/lib/classes/spooled_markdown_artifact.ts#L29) |