Skip to content

Printer

Renders parsed documentation models as Markdown.

3 exports Added in v0.6.0 Source

Printers

prettify

Added in v0.6.0 Source

Formats generated Markdown with the docgen Prettier settings.

Signature

declare function prettify(s: string): Effect<string, never, never>;

printFrontMatter

Added in v0.6.0 Source

Renders the front matter for a generated module page.

Signature

declare function printFrontMatter(module: Module, nav_order: number): string;

printModule

Added in v0.6.0 Source

Renders a parsed module as a Markdown documentation page.

Signature

declare function printModule(module: Module): Effect<string, never, Configuration>;