2015-05-13 09:31:30 -04:00
|
|
|
---
|
2017-05-23 14:00:36 -04:00
|
|
|
date: 2017-05-23T20:59:46+03:00
|
2015-11-25 17:11:16 -05:00
|
|
|
title: "hugo gen doc"
|
|
|
|
slug: hugo_gen_doc
|
|
|
|
url: /commands/hugo_gen_doc/
|
2015-05-13 09:31:30 -04:00
|
|
|
---
|
2015-11-25 17:11:16 -05:00
|
|
|
## hugo gen doc
|
2015-05-13 09:31:30 -04:00
|
|
|
|
|
|
|
Generate Markdown documentation for the Hugo CLI.
|
|
|
|
|
|
|
|
### Synopsis
|
|
|
|
|
|
|
|
|
|
|
|
Generate Markdown documentation for the Hugo CLI.
|
2015-08-04 05:15:12 -04:00
|
|
|
|
|
|
|
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.
|
2015-05-13 09:31:30 -04:00
|
|
|
|
|
|
|
```
|
2017-05-23 14:00:36 -04:00
|
|
|
hugo gen doc [flags]
|
2015-05-13 09:31:30 -04:00
|
|
|
```
|
|
|
|
|
|
|
|
### Options
|
|
|
|
|
|
|
|
```
|
2016-04-09 17:01:55 -04:00
|
|
|
--dir string the directory to write the doc. (default "/tmp/hugodoc/")
|
2017-04-26 16:40:21 -04:00
|
|
|
-h, --help help for doc
|
2015-05-13 09:31:30 -04:00
|
|
|
```
|
|
|
|
|
|
|
|
### Options inherited from parent commands
|
|
|
|
|
|
|
|
```
|
2016-10-05 04:23:45 -04:00
|
|
|
--config string config file (default is path/config.yaml|json|toml)
|
2017-04-26 16:40:21 -04:00
|
|
|
--log enable Logging
|
|
|
|
--logFile string log File path (if set, logging enabled automatically)
|
2016-12-20 03:39:12 -05:00
|
|
|
--quiet build in quiet mode
|
2016-04-09 17:01:55 -04:00
|
|
|
-v, --verbose verbose output
|
|
|
|
--verboseLog verbose logging
|
2015-05-13 09:31:30 -04:00
|
|
|
```
|
|
|
|
|
|
|
|
### SEE ALSO
|
2015-11-25 17:11:16 -05:00
|
|
|
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
|
2015-05-13 09:31:30 -04:00
|
|
|
|
2017-05-23 14:00:36 -04:00
|
|
|
###### Auto generated by spf13/cobra on 23-May-2017
|