quarto_doc_short

Notedocblock

quarto_doc_short(b; page_name = nothing)

Create a short reference-index entry for a binding or value b. Used by quarto_build_refpage to build the reference index.

Returns a Vector{String}, one entry per docstring block. For each block:

• If the block starts with a signature code block, the entry links the rendered signature to its per-function page and follows it with a blockquote of the first paragraph.
• If the block starts with a paragraph (no signature), the entry links the page name to its per-function page and follows it with a (truncated) blockquote of the first paragraph. When page_name is given it is used as the reference page file stem (the link target reference/<page_name>.qmd); otherwise it is derived from b via _doc_page_name, preserving the default behaviour. Pass an explicit page_name to keep collision-safe submodule page names consistent.

This function never throws on a well-formed Markdown.MD.