mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
ec920363cd
4c5edacfe cSpell config update (#1700) 9df788b25 Fix broken link (hugo modules) (#1710) 9928a70d6 Fix workspace formatting (#1707) 55467e7c8 Update partials.md 9f4bd0023 Update formats.md 9b3913c86 Remove footnoteAnchorPrefix and footnoteReturnLinkContents (#1704) 94502a09b Code block render hooks are introduced in v0.93.0 (#1701) c447270ef Update sitemap-template.md 78665c1e0 Update sitemap-template.md 60653c17d Update the caddy error docs link (#1696) 9a3675aad Update sitemap templates (#1699) e0d08cdbb Add wpxr-to-static to list of migration tools (#1512) b53eb5a08 Add page for deploying with rclone (#1511) 4207c57ff netlify: Hugo 0.96.0 a18d646ea docs: Regen docshelper e3e0981ed docs: Regen CLI docs fda988d01 Merge commit 'd276e901b36d2576ef8350ed96b17f66254eac1b' e4a26dbca tpl/crypto: Add optional encoding arg to hmac function git-subtree-dir: docs git-subtree-split: 4c5edacfeebd13eb7f876723c065466cd50e0cae
51 lines
1.5 KiB
Markdown
51 lines
1.5 KiB
Markdown
---
|
|
title: "hugo gen doc"
|
|
slug: hugo_gen_doc
|
|
url: /commands/hugo_gen_doc/
|
|
---
|
|
## hugo gen doc
|
|
|
|
Generate Markdown documentation for the Hugo CLI.
|
|
|
|
### Synopsis
|
|
|
|
Generate Markdown documentation for the Hugo CLI.
|
|
|
|
This command is, mostly, used to create up-to-date documentation
|
|
of Hugo's command-line interface for https://gohugo.io/.
|
|
|
|
It creates one Markdown file per command with front matter suitable
|
|
for rendering in Hugo.
|
|
|
|
```
|
|
hugo gen doc [flags]
|
|
```
|
|
|
|
### Options
|
|
|
|
```
|
|
--dir string the directory to write the doc. (default "/tmp/hugodoc/")
|
|
-h, --help help for doc
|
|
```
|
|
|
|
### Options inherited from parent commands
|
|
|
|
```
|
|
--config string config file (default is path/config.yaml|json|toml)
|
|
--configDir string config dir (default "config")
|
|
--debug debug output
|
|
-e, --environment string build environment
|
|
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
|
|
--log enable Logging
|
|
--logFile string log File path (if set, logging enabled automatically)
|
|
--quiet build in quiet mode
|
|
-s, --source string filesystem path to read files relative from
|
|
--themesDir string filesystem path to themes directory
|
|
-v, --verbose verbose output
|
|
--verboseLog verbose logging
|
|
```
|
|
|
|
### SEE ALSO
|
|
|
|
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
|
|
|