mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-07 20:30:36 -05:00
60 lines
2.1 KiB
Markdown
60 lines
2.1 KiB
Markdown
---
|
|
date: 2015-09-08T22:45:13-06:00
|
|
title: "hugo gendoc"
|
|
slug: hugo_gendoc
|
|
url: /commands/hugo_gendoc/
|
|
---
|
|
## hugo gendoc
|
|
|
|
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 gendoc
|
|
```
|
|
|
|
### Options
|
|
|
|
```
|
|
--dir="/tmp/hugodoc/": the directory to write the doc.
|
|
```
|
|
|
|
### Options inherited from parent commands
|
|
|
|
```
|
|
-b, --baseURL="": hostname (and path) to the root, e.g. http://spf13.com/
|
|
-D, --buildDrafts[=false]: include content marked as draft
|
|
-F, --buildFuture[=false]: include content with publishdate in the future
|
|
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
|
|
--config="": config file (default is path/config.yaml|json|toml)
|
|
-d, --destination="": filesystem path to write files to
|
|
--disableRSS[=false]: Do not build RSS files
|
|
--disableSitemap[=false]: Do not build Sitemap file
|
|
--editor="": edit new content with this editor, if provided
|
|
--ignoreCache[=false]: Ignores the cache directory for reading but still writes to it
|
|
--log[=false]: Enable Logging
|
|
--logFile="": Log File path (if set, logging enabled automatically)
|
|
--pluralizeListTitles[=true]: Pluralize titles in lists using inflect
|
|
--preserveTaxonomyNames[=false]: Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
|
|
-s, --source="": filesystem path to read files relative from
|
|
--stepAnalysis[=false]: display memory and timing of different steps of the program
|
|
-t, --theme="": theme to use (located in /themes/THEMENAME/)
|
|
--uglyURLs[=false]: if true, use /filename.html instead of /filename/
|
|
-v, --verbose[=false]: verbose output
|
|
--verboseLog[=false]: verbose logging
|
|
```
|
|
|
|
### SEE ALSO
|
|
* [hugo](/commands/hugo/) - hugo builds your site
|
|
|
|
###### Auto generated by spf13/cobra on 8-Sep-2015
|