Record
Rendered
Module PuduLangDocgen.Api.Sheet
type Rendered = {
title: Str,
body: Str,
headings: Array[Docgen.Heading],
links: Array[Docgen.Link],
diagnostics: Array[Docgen.Diagnostic]
}The rendered title, body, outline, and findings of a page
Fields
| Name | Type | Description |
|---|---|---|
title |
Str |
|
body |
Str |
|
headings |
Array[Docgen.Heading] |
|
links |
Array[Docgen.Link] |
|
diagnostics |
Array[Docgen.Diagnostic] |
Related functions
| Name | Description |
|---|---|
render |
A page from an API page document: `title`, optional `languageId`, and a `body` of blocks named `h1`–`h6`, `api1`–`api4`, `markdown`, `code`, `facts`, `parameters`, `list`, and `inheritance`. Unknown blocks are reported and skipped. |