packages.yml

YAML83 lines3.1 KB

Copy pathGitHub ↗

1### YamlMime:Dashboard2title: Packages3description: |4  pudu-lang-docgen is distributed as one Pudu package. Its modules are grouped below by the job5  they do, so you can find the entry point you need before opening the full6  <xref:PuduLangDocgen?text=API+reference>.7items:8- name: pudu-lang-docgen9  description: |10    Documentation publishing for Pudu: articles, API reference, HTTP API reference, navigation,11    search, and static websites. Every module lives under `PuduLangDocgen`.12  type: Package13  author: Chris Michael14  version: 0.1.015  license: Apache-2.016  thumbnail: ../images/pudu-lang-short.png17  homepage: ../guides/introduction.html18  repository:19    url: https://github.com/chrismichaelps/pudu-lang-docgen20  usage:21    install: pudu install @chrismichaelps/pudu-lang-docgen22    config: '"@chrismichaelps/pudu-lang-docgen" = "0.1.0"'23- name: PuduLangDocgen.Command24  description: |25    The command line as a function. `Command.run` takes the process arguments and answers an26    exit status, so a two-line program gives a project the full `docgen` command.27  type: Module28  author: Chris Michael29  version: 0.1.030  license: Apache-2.031  thumbnail: ../images/pudu-lang-short.png32  homepage: ../api/PuduLangDocgen.Command.html33  repository:34    url: https://github.com/chrismichaelps/pudu-lang-docgen/blob/main/src/PuduLangDocgen/Command.pudu35  usage:36    init: import PuduLangDocgen.Command as Command37    command: Command.run(&Env.all())38- name: PuduLangDocgen.Docset39  description: |40    Projects on disk: load a configuration, build and publish incrementally, write API metadata,41    and print PDFs.42  type: Module43  author: Chris Michael44  version: 0.1.045  license: Apache-2.046  thumbnail: ../images/pudu-lang-short.png47  homepage: ../api/PuduLangDocgen.Docset.html48  repository:49    url: https://github.com/chrismichaelps/pudu-lang-docgen/blob/main/src/PuduLangDocgen/Docset.pudu50  usage:51    init: import PuduLangDocgen.Docset as Docset52    command: Docset.build("docs/docgen.json", &Docset.options(), &Build.extensions())53- name: PuduLangDocgen.Build54  description: |55    The validated site plan as a pure function of loaded input, with page transforms and output56    post-processors through `Build.Extensions`.57  type: Module58  author: Chris Michael59  version: 0.1.060  license: Apache-2.061  thumbnail: ../images/pudu-lang-short.png62  homepage: ../api/PuduLangDocgen.Build.html63  repository:64    url: https://github.com/chrismichaelps/pudu-lang-docgen/blob/main/src/PuduLangDocgen/Build.pudu65  usage:66    init: import PuduLangDocgen.Build as Build67    command: Build.plan(&loaded.input, &Build.extensions())68- name: PuduLangDocgen.Configuration69  description: |70    The typed `docgen.json` model. `Configuration.parse` reads JSON or YAML and reports the exact71    location of every invalid value.72  type: Module73  author: Chris Michael74  version: 0.1.075  license: Apache-2.076  thumbnail: ../images/pudu-lang-short.png77  homepage: ../api/PuduLangDocgen.Configuration.html78  repository:79    url: https://github.com/chrismichaelps/pudu-lang-docgen/blob/main/src/PuduLangDocgen/Configuration.pudu80  usage:81    init: import PuduLangDocgen.Configuration as Configuration82    command: Configuration.parse("docgen.json", text)83