markdown (slug.doc)

slug.doc.markdown

slug.doc.markdown — Markdown API documentation generator

Reflects over live Slug modules using slug.meta#describe and renders a single-page markdown file with standard API documentation style.

Each module gets a level-2 section with its doc comment as a lead paragraph, followed by subsections for Constants, Structs, and Functions. Overloaded functions are grouped under a single heading with multiple signature blocks.

Output is designed for rendering on GitHub, static site generators, or any standard markdown renderer.

TOC

• pagePerModule(moduleNames, moduleToc)
• singlePage(moduleNames, title, moduleToc)

Functions

pagePerModule(moduleNames, moduleToc)

fn slug.doc.markdown#pagePerModule(@list moduleNames, @bool moduleToc = false) -> @list

generates a multi-page markdown API reference for the given list of module names, returns [name, text].

each module gets a level-2 section with subsections for Constants, Structs, and Functions. overloaded functions are grouped under a single heading. all doc comments are rendered in full.

pass the full dotted module names as they would appear in an import statement.

singlePage(moduleNames, title, moduleToc)

fn slug.doc.markdown#singlePage(@list moduleNames, @str title = "Slug API Reference", @bool moduleToc = false) -> @str

generates a single-page markdown API reference for the given list of module names.

modules are sorted alphabetically. each module gets a level-2 section with subsections for Constants, Structs, and Functions. overloaded functions are grouped under a single heading. all doc comments are rendered in full.

pass the full dotted module names as they would appear in an import statement.