@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
template.md
template
uid: guides.commands.template description: List the built-in templates or export the default template's files for customizing.
Lists the built-in templates or copies the default template into a folder so it can be customized.
docgen template list
docgen template export [folder] [options]template list
Prints the names of the built-in templates, one per line:
default
modernmodern is another name for default.
template export
Writes the default template's files into a folder:
| File | Description |
|---|---|
layout.html | The page layout. |
partials/*.html | Every partial: actions, affix, breadcrumb, footer, head, header, pager, scripts, sidebar. |
reference/site.css, reference/site.js | The default stylesheet and script, for reference. They are not loaded from the template folder. |
public/main.css, public/main.js | Empty files that are loaded after the defaults. |
| Argument or option | Description |
|---|---|
folder | Where to write the files. |
-o, --output <folder> | The same, when no folder argument is given. Defaults to _exported_templates/default. |
Add the folder to build.template after default, then delete every file you do not change, so that later versions of the default template still apply to them.
Example
pudu run Docgen.pudu template export docs/template"template": ["default", "template"]