Packages
pudu-lang-docgen is distributed as one Pudu package. Its modules are grouped below by the job they do, so you can find the entry point you need before opening the full API reference.
pudu-lang-docgen
Documentation publishing for Pudu: articles, API reference, HTTP API reference, navigation,
search, and static websites. Every module lives under PuduLangDocgen.
- Install
pudu install @chrismichaelps/pudu-lang-docgen- Configuration
"@chrismichaelps/pudu-lang-docgen" = "0.1.0"
PuduLangDocgen.Command
The command line as a function. Command.run takes the process arguments and answers an
exit status, so a two-line program gives a project the full docgen command.
- Get
import PuduLangDocgen.Command as Command- Command line
Command.run(&Env.all())
PuduLangDocgen.Docset
Projects on disk: load a configuration, build and publish incrementally, write API metadata, and print PDFs.
- Get
import PuduLangDocgen.Docset as Docset- Command line
Docset.build("docs/docgen.json", &Docset.options(), &Build.extensions())
PuduLangDocgen.Build
The validated site plan as a pure function of loaded input, with page transforms and output
post-processors through Build.Extensions.
- Get
import PuduLangDocgen.Build as Build- Command line
Build.plan(&loaded.input, &Build.extensions())
PuduLangDocgen.Configuration
The typed docgen.json model. Configuration.parse reads JSON or YAML and reports the exact
location of every invalid value.
- Get
import PuduLangDocgen.Configuration as Configuration- Command line
Configuration.parse("docgen.json", text)