Module

PuduLangDocgen.Configuration

The typed project configuration of a documentation site

Types

Name	Description
`Mapping`	Files matched by globs under a source folder, published under a destination
`ApiSource`	Pudu sources documented as reference pages
`Contribution`	The repository behind edit links
`Diagrams`	How PlantUML diagrams are drawn
`Pdf`	The command that turns printable documents into PDF files
`Config`	Everything a build reads from the project configuration

Name	Description
`defaults`	Settings used when a configuration names nothing else.
`parse`	A configuration read from JSON or YAML text; the file name decides the format and appears in every diagnostic.

fn defaults() -> Config

Settings used when a configuration names nothing else.

fn parse(file: Str, text: Str) -> Result[Config, Array[Docgen.Diagnostic]]

A configuration read from JSON or YAML text; the file name decides the format and appears in every diagnostic.

Name	Description
`LEVELS`	Levels a rule may assign to a diagnostic code.

const LEVELS: Array[Str] = ["error", "warning", "info", "off"]

Levels a rule may assign to a diagnostic code.

Array[Str]