Module
PuduLangDocgen.Navigation
Table of contents files read into nested items
Types
| Name | Description |
|---|---|
Toc |
Items of one table of contents with its own metadata |
Functions
| Name | Description |
|---|---|
isToc |
Whether a project-relative path names a table of contents file. |
parse |
A table of contents written as YAML, JSON, or Markdown headings. An object form holds `items` beside metadata such as `order` or `pdf`. Hrefs are kept as written; resolution happens against the published docset. |
markdown |
Items of a Markdown table of contents: each heading level nests one deeper. `# [Title](href)` links an item; `# Title` makes a group. |
forPages |
Items for published pages when no table of contents exists, ordered by path. |
toJson |
Items as JSON with `name`, `href`, `expanded`, and nested `items`. |
isToc
fn isToc(path: Str) -> BoolWhether a project-relative path names a table of contents file.
Parameters
pathStr
Returns
Bool
parse
fn parse(path: Str, text: Str) -> Result[Toc, Array[Docgen.Diagnostic]]A table of contents written as YAML, JSON, or Markdown headings. An object form holds
items beside metadata such as order or pdf. Hrefs are kept as written; resolution
happens against the published docset.
Parameters
pathStrtextStr
Returns
Result[Toc, Array[Docgen.Diagnostic]]
markdown
fn markdown(path: Str, text: Str) -> Result[Array[Docgen.TocItem], Array[Docgen.Diagnostic]]Items of a Markdown table of contents: each heading level nests one deeper.
# [Title](href) links an item; # Title makes a group.
Parameters
pathStrtextStr
Returns
Result[Array[Docgen.TocItem], Array[Docgen.Diagnostic]]
forPages
fn forPages(pages: &Array[Docgen.Page]) -> Array[Docgen.TocItem]Items for published pages when no table of contents exists, ordered by path.
Parameters
pages&Array[Docgen.Page]
Returns
Array[Docgen.TocItem]
toJson
fn toJson(tree: &Array[Docgen.TocItem]) -> Json.JsonItems as JSON with name, href, expanded, and nested items.
Parameters
tree&Array[Docgen.TocItem]
Returns
Json.Json