mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
5e078383a7
49809a03 Merge commit '20a631b4964fc0ab9137cce1e41774cbc17de044' 20a631b4 Squashed 'themes/gohugoioTheme/' changes from b8202f539..dafc91ff1 8b58f565 Re-generate CLI docs 4653a724 Add Netlify deployment badge 2d6246bc Remove some deprecated site variables e6777153 Improve Algolia Search Display Styling 1570999f Add missing "." in front of gitlab-ci.yaml example b922ae7d This adds documentation to the new configDir/Environment logic from .53 (#729) 7cff379f Correctly escape multi-word taxonomy terms in example 2dfeeda4 fix typo by removing stray paren 0870bd9a Fix typo in `paginate` description 91e8be85 Fixes https://github.com/gohugoio/hugo/issues/5609 c1db65ec Make the dummy URL more obvious b4589ff0 Fix a link b73dcb9a Consistently use "posts" as section name in examples 7a56abbc Format definitions a9c6fd9b Minor clarification over the last commit 5c86bdc8 Add alternative instructions for Quick Start for non-git users dafe7ee9 Add Visual Studio Code plug-ins 110ed19e Update HUGO_VERSION 2abd031a Update page.md b332f7b9 Update page.md f5a8c9d4 Update static-files.md 6d0c155c Add note about relative protocol URLs a13751ac Theme Warning: Remove note about unquoted URLs 4c8f7d68 Incorporate feedback 6f2b9cf0 Update Creating Themes Warning 40d88d98 Fix ToC example to use binary true/false 4a11f3f1 Fix typo 2dbfc0a4 Fix a typo in taxonomies d63790ef Do not mark UndocumentedFeature issues as stale d7aff095 Regenerate docs.json 71c0826f Update transform.Unmarshal.md git-subtree-dir: docs git-subtree-split: 49809a038b2691637bab7f3f2e385dde654a88b8
49 lines
1.2 KiB
Markdown
49 lines
1.2 KiB
Markdown
---
|
|
date: 2019-01-30
|
|
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 http://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
|
|
--log enable Logging
|
|
--logFile string log File path (if set, logging enabled automatically)
|
|
--quiet build in quiet mode
|
|
-v, --verbose verbose output
|
|
--verboseLog verbose logging
|
|
```
|
|
|
|
### SEE ALSO
|
|
|
|
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
|
|
|
|
###### Auto generated by spf13/cobra on 30-Jan-2019
|