Record

Options

type Options = {
  dest: Str,
  includePrivate: Bool,
  include: Array[Str],
  exclude: Array[Str],
  rules: Array[Rule],
  sourceUrl: Str,
  sourceExclude: Array[Str],
  nested: Bool,
  separate: Bool,
  skipMarkup: Bool,
  alphabetic: Bool,
  categories: Str
}

View source

Where reference pages go and which declarations they show

Fields

Name	Type	Description
`dest`	`Str`
`includePrivate`	`Bool`
`include`	`Array[Str]`
`exclude`	`Array[Str]`
`rules`	`Array[Rule]`
`sourceUrl`	`Str`
`sourceExclude`	`Array[Str]`
`nested`	`Bool`
`separate`	`Bool`
`skipMarkup`	`Bool`
`alphabetic`	`Bool`
`categories`	`Str`

Name	Description
`defaults`	Options that show exported declarations under `api` with default layouts.
`select`	Declarations kept for publication: exported ones unless private ones are asked for, whose identity matches an include pattern when any is given and no exclude pattern.
`pageOf`	The published path of a module or type page.
`references`	Identities of every module, declaration, field, variant, and method with its destination. Modules and types have pages; functions and constants are sections of their module page, and fields, variants, and methods sections of their type page.
`toc`	Navigation of modules, each listing its types and traits, and its functions and constants when they have pages of their own. Items carry the identity they link to. Nested navigation groups modules under the modules their names extend.
`sourceLink`	A browser link to a declaration's source line, or the empty text without a pattern. The pattern names `\{path\}` and `\{line\}`.