Module
PuduLangDocgen.Build.Site
Navigation, page frames, templated pages, and site-wide files
Types
| Name | Description |
|---|---|
Book |
A resolved table of contents with where it publishes and its metadata |
Context |
What every page of the site is framed with |
Functions
| Name | Description |
|---|---|
books |
Tables of contents resolved against the site; entries without an output only serve as targets of other tables. Tables another table links are nested and rank after tables of their own folder unless they declare an `order`. |
rendered |
Every page rendered through the layout, with redirect pages standing alone. |
files |
Site-wide files: tables of contents as JSON, the search index, the sitemap, and the cross-reference map. |
notFound |
A generated page for addresses the site does not have. |
manifest |
The manifest listing every output with its source and kind, and the generator version. |
pdfOf |
The PDF a table publishes: `pdfFileName` beside the table, `toc.pdf` by default. |
books
fn books(tocs: &Array[(Str, Str, Navigation.Toc)], links: &Resolve.Links) -> (Array[Book], Array[Docgen.Diagnostic])Tables of contents resolved against the site; entries without an output only serve as
targets of other tables. Tables another table links are nested and rank after tables of
their own folder unless they declare an order.
Parameters
tocs&Array[(Str, Str, Navigation.Toc)]links&Resolve.Links
Returns
(Array[Book], Array[Docgen.Diagnostic])
rendered
fn rendered(pages: &Array[Docgen.Page], context: &Context) -> Array[Docgen.Artifact]Every page rendered through the layout, with redirect pages standing alone.
Parameters
pages&Array[Docgen.Page]context&Context
Returns
Array[Docgen.Artifact]
files
fn files(pages: &Array[Docgen.Page], references: &Array[Docgen.Reference], context: &Context) -> Array[Docgen.Artifact]Site-wide files: tables of contents as JSON, the search index, the sitemap, and the cross-reference map.
Parameters
pages&Array[Docgen.Page]references&Array[Docgen.Reference]context&Context
Returns
Array[Docgen.Artifact]
notFound
fn notFound(global: &Array[(Str, Docgen.Meta)]) -> Docgen.PageA generated page for addresses the site does not have.
Parameters
global&Array[(Str, Docgen.Meta)]
Returns
manifest
fn manifest(pages: &Array[Docgen.Page], resources: &Array[(Str, Str)], generator: Str, outputs: &Array[Str]) -> StrThe manifest listing every output with its source and kind, and the generator version.
Parameters
pages&Array[Docgen.Page]resources&Array[(Str, Str)]generatorStroutputs&Array[Str]
Returns
Str
pdfOf
The PDF a table publishes: pdfFileName beside the table, toc.pdf by default.
Parameters
book&Book
Returns
Str