hugo/content/commands/hugo_gen_doc.md
Bjørn Erik Pedersen 37c69054e2 Squashed 'docs/' changes from 5d9a6703..f3c88b08
f3c88b08 Add warning on GitInfo and Shallow Clones
fa5be591 Make the two common Taxonomy templates explicit
4a81c507 Update pull request link in showcase.html
f751e57a Update christianmendoza.me in the showcase
d582419b Remove commit message prefix from showcase addition guide
d12791cf Fix path for screenshot in showcase addition guide
e487b916 Add invincible.site to the showcase
c85cfccf Update guide for showcase additions
c44b31c1 Fix spelling
dc10d7f6 Add slightly better GitHub install description
2611980f Revert "Add workaround to Fetch from GitHub documentation"
b2e56907 Fix Git commit link in footer
b025a638 Regenerate commands docs for v0.24.1
0741ad08 Update README.md
942d130a Add branch info to README
e8c36390 Set hugoDocs/master to 0.24.1
c4e21471 Add workaround to Fetch from GitHub documentation
db0a3c08 Fix typo in release note

git-subtree-dir: docs
git-subtree-split: f3c88b081022c945f010cdbfcd25e0008e0c3f5b
2017-07-06 10:25:46 +02:00

47 lines
1.1 KiB
Markdown

---
date: 2017-06-29T08:42:09+02:00
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)
--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 29-Jun-2017