Skip to main content

outline

Function outline 

Source
pub fn outline(store: &Store, file: &Path) -> Result<Outline, StoreError>
Expand description

Build the Outline of a single file from its ## (and deeper) sections. Loop-fast (one file).

file may be given store-relative or absolute; the read resolves against Store::root when relative, and Outline::file is always normalized to the store-relative form. Sections are extracted over the file body (after the YAML frontmatter), so Section::line is 1-based within the body — the same frame crate::parser::extract_sections uses. Only ## and deeper headings are sections (a single leading # title is not a section); headings inside fenced code blocks are not mistaken for real headings.