@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
metadata.md
metadata
uid: guides.commands.metadata description: Write API metadata files for the configured Pudu sources without building the site.
Reads the Pudu sources named by the configuration's metadata section and writes their model as files, without building the site.
docgen metadata [config] [options]Each source is written in its outputFormat (json, markdown, or apiPage) under its dest folder, together with a toc.yml. The command prints wrote <path> for every file.
| Option | Description |
|---|---|
-o, --output <folder> | Write every source's files to this folder instead of each dest. |
Example
pudu run Docgen.pudu metadata docs --output docs/referenceWith "outputFormat": "apiPage", the written files can be listed as content in another project, which renders them as reference pages. See [Pudu API reference](../api-reference.md#metadata-files).