Skip to main content

Module guide

Module guide 

Source
Expand description

Embedded or file-backed guide parsing.

Structs§

GuideEntry
Parsed guide document.

Functions§

guide_content
Returns either the guide topic list or one guide’s content.
list_guides
Renders the guide topic list.
parse_front_matter
Parses optional YAML front matter and returns (summary, body).
parse_guides
Parses all markdown guide files under a directory.
parse_guides_from_markdown
Parses guide entries from embedded (path, bytes) markdown pairs.