@chrismichaelps / pudu-lang-docgen
Documentation publishing for Pudu: articles, API references, navigation, search, and static websites
0.1.0Apache-2.01
InstallClose
Use @chrismichaelps/pudu-lang-docgen
Install this release
From your project, run:
pudu install @chrismichaelps/pudu-lang-docgen@0.1.0An exact version can install a new release immediately. Without a version, pudu follows the 72-hour minimum release age for new resolutions.
pudu install @chrismichaelps/pudu-lang-docgenThen import it
import PuduLangDocgen as PuduLangDocgenTo contribute
git clone https://github.com/chrismichaelps/pudu-lang-docgen
download.md
download
uid: guides.commands.download description: Save another site's cross-reference map to a local file.
Fetches a cross-reference map from a web address and saves it as a file, so that builds can use it without network access.
docgen download <file> --xref <address>| Argument or option | Description |
|---|---|
file | The file to write. A .json name writes JSON; any other name writes YAML. |
-x, --xref <address> | The address of the map to fetch. Required. |
Relative addresses in the map are made absolute against the map's baseUrl, or against the address it was fetched from, so the saved file works from any project. The command prints saved <n> references to <file>.
It fails with DG904 when the map cannot be fetched or read, and exits with status 2 when the file or --xref is missing.
Example
pudu run Docgen.pudu download maps/docgen.yml --xref https://www.pudu-lang-docgen.com/xrefmap.ymlThen list the file in the configuration:
"xref": ["maps/docgen.yml"]