Documentation
¶
Overview ¶
Package docsmd holds the small Markdown transforms shared by the two documentation-site generators — tools/docsgen (guide pages from the skill and README) and fft gen-docs (the CLI reference).
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func EscapeAngles ¶
EscapeAngles escapes a bare '<' (to <) that sits outside fenced and inline code, so a placeholder like <id> in prose is not parsed as an HTML tag.
VitePress compiles rendered Markdown as a Vue template, and a stray "<id>" reads as an element with no closing tag — a hard build error. Only '<' opens a tag, so only '<' is touched: '>' is left alone, both because it opens nothing and because escaping it would mangle a blockquote marker. Code is left untouched too — there Markdown already escapes the angle brackets, and escaping again would show the entities raw.
func IsFenceDelimiter ¶
IsFenceDelimiter reports whether a line opens or closes a fenced code block — a (possibly indented) run of at least three backticks or tildes. Both this package and tools/docsgen walk Markdown line-by-line tracking fence state, and must agree on what a fence looks like or one of them will silently process text the other treats as code.
Types ¶
This section is empty.