mirror of
https://github.com/gohugoio/hugo.git
synced 2024-05-11 05:54:58 +00:00
55 lines
1.8 KiB
Markdown
55 lines
1.8 KiB
Markdown
|
---
|
||
|
|
date: 2015-05-13T11:12:54+02: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.
|
||
|
|
|
||
|
|
```
|
||
|
|
hugo gendoc
|
||
|
|
```
|
||
|
|
|
||
|
|
### Options
|
||
|
|
|
||
|
|
```
|
||
|
|
--dir="/tmp/hugodoc/": the directory to write the doc.
|
||
|
|
-h, --help=false: help for gendoc
|
||
|
|
```
|
||
|
|
|
||
|
|
### Options inherited from parent commands
|
||
|
|
|
||
|
|
```
|
||
|
|
-b, --baseUrl="": hostname (and path) to the root eg. http://spf13.com/
|
||
|
|
-D, --buildDrafts=false: include content marked as draft
|
||
|
|
-F, --buildFuture=false: include content with datePublished 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
|
||
|
|
-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 is a very fast static site generator
|
||
|
|
|
||
|
|
###### Auto generated by spf13/cobra at 2015-05-13 09:12:54.404218224 +0000 UTC
|