Documentation
¶
Overview ¶
Package index renders index.md: a navigable flat index of every document by canonical DocumentID, with a one-line description (front matter → first H1 fallback), category/section, and mod-date. It is a dual-purpose human TOC and agent-navigation surface (the curated/importance-ordered index pattern). It is infrastructure: it reads the frozen emit.View and never mutates the domain (ADR 0004), and output is deterministic.
Index ¶
Constants ¶
const IndexMarkdownName = "index.md"
IndexMarkdownName is the conventional index filename.
Variables ¶
This section is empty.
Functions ¶
func Markdown ¶
Markdown renders index.md from the View. Documents are grouped by category (their directory), categories sorted, documents within a category sorted by DocumentID — fully deterministic. Each entry lists the canonical DocumentID, its description, and its mod-date. Every emitted string is escaped via the shared emit escape helpers (the SAME ones the Markdown report uses) so a hostile title/path/category cannot break the GFM table or inject markdown (ADR 0003).
index.md is a consumption surface (ADR 0019): emit-excluded documents are dropped from the entries and from the Backlinks column, the header count reflects what is rendered, and a note states how many docs were filtered so the artifact is honest about it. Byte-identical to the unfiltered output when no emitExclude patterns are active.
Types ¶
This section is empty.
Source Files