Record

Book

Module PuduLangDocgen.Build.Site

type Book = {
  output: Str,
  items: Array[Docgen.TocItem],
  meta: Array[(Str, Docgen.Meta)],
  nested: Bool
}

View source

A resolved table of contents with where it publishes and its metadata

Fields

Name Type Description
output Str
items Array[Docgen.TocItem]
meta Array[(Str, Docgen.Meta)]
nested Bool
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`.
pdfOf The PDF a table publishes: `pdfFileName` beside the table, `toc.pdf` by default.