tools.yml

YAML91 lines3.3 KB

Copy pathGitHub ↗

1### YamlMime:Dashboard2title: Tools3description: |4  Programs and commands that ship with pudu-lang-docgen. Each one is a thin program over the5  library, so the same behavior is available from Pudu code; see [Library usage](../guides/library.md).6items:7- name: Command line8  description: |9    `examples/Cli.pudu` runs the full `docgen` command line: build, metadata, serve, init, pdf,10    template, download, merge, version, and help.11  type: Tool12  author: Chris Michael13  version: 0.1.014  license: Apache-2.015  thumbnail: ../images/pudu-lang-short.png16  homepage: ../guides/commands/index.html17  repository:18    url: https://github.com/chrismichaelps/pudu-lang-docgen/blob/main/examples/Cli.pudu19  usage:20    command: pudu run examples/Cli.pudu build website21- name: Build program22  description: |23    `examples/BuildSite.pudu` builds the sample project in `examples/site` by calling24    `Docset.build` directly, and prints each diagnostic and a summary.25  type: Tool26  author: Chris Michael27  version: 0.1.028  license: Apache-2.029  thumbnail: ../images/pudu-lang-short.png30  homepage: ../guides/library.html31  repository:32    url: https://github.com/chrismichaelps/pudu-lang-docgen/blob/main/examples/BuildSite.pudu33  usage:34    command: pudu run examples/BuildSite.pudu35- name: Preview server36  description: |37    Serves a built site over HTTP, answering missing addresses with the site's not-found page.38    With `build --serve --watch`, the site is rebuilt whenever a project file changes.39  type: Command40  author: Chris Michael41  version: 0.1.042  license: Apache-2.043  thumbnail: ../images/pudu-lang-short.png44  homepage: ../guides/commands/serve.html45  repository:46    url: https://github.com/chrismichaelps/pudu-lang-docgen/blob/main/src/PuduLangDocgen/Serve.pudu47  usage:48    command: docgen build docs --serve --watch49- name: Project scaffolding50  description: |51    Creates a documentation project with a configuration, a landing page, starter articles,52    navigation, and an optional API section.53  type: Command54  author: Chris Michael55  version: 0.1.056  license: Apache-2.057  thumbnail: ../images/pudu-lang-short.png58  homepage: ../guides/commands/init.html59  repository:60    url: https://github.com/chrismichaelps/pudu-lang-docgen/blob/main/src/PuduLangDocgen/Scaffold.pudu61  usage:62    init: docgen init docs --yes63- name: PDF printing64  description: |65    Prints a PDF for every table of contents that sets `pdf`, using an installed browser or a66    renderer you configure.67  type: Command68  author: Chris Michael69  version: 0.1.070  license: Apache-2.071  thumbnail: ../images/pudu-lang-short.png72  homepage: ../guides/pdf.html73  repository:74    url: https://github.com/chrismichaelps/pudu-lang-docgen/blob/main/src/PuduLangDocgen/Site/Print.pudu75  usage:76    command: docgen pdf docs77    config: '"pdf": { "renderer": ["chromium", "--headless=new", "--print-to-pdf={output}", "{url}"] }'78- name: Cross-reference maps79  description: |80    Saves another site's map for offline builds and combines several maps into one.81  type: Command82  author: Chris Michael83  version: 0.1.084  license: Apache-2.085  thumbnail: ../images/pudu-lang-short.png86  homepage: ../guides/cross-references.html#cross-reference-maps87  repository:88    url: https://github.com/chrismichaelps/pudu-lang-docgen/blob/main/src/PuduLangDocgen/References.pudu89  usage:90    command: docgen download maps/site.yml --xref https://www.pudu-lang-docgen.com/xrefmap.yml91