HUGO
Menu
GitHub 90498 stars Mastodon

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 https://gohugo.io/.

It creates one Markdown file per command with front matter suitable
for rendering in Hugo.
hugo gen doc [flags] [args]

Options

--dir string          the directory to write the doc. (default "/tmp/hugodoc/")
  -h, --help[=true|false]   help for doc

Options inherited from parent commands

--clock string                  set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
      --config string                 config file (default is hugo.yaml|json|toml)
      --configDir string              config dir (default "config")
  -d, --destination string            filesystem path to write files to
  -e, --environment string            build environment
      --ignoreVendorPaths string      ignores any _vendor for module paths matching the given Glob pattern
      --logLevel string               log level (debug|info|warn|error)
      --noBuildLock[=true|false]      don't create .hugo_build.lock file
      --quiet[=true|false]            build in quiet mode
  -M, --renderToMemory[=true|false]   render to memory (mostly useful when running the server)
  -s, --source string                 filesystem path to read files relative from
      --themesDir string              filesystem path to themes directory

SEE ALSO

  • hugo gen - Generate documentation and syntax highlighting styles