hugo/docs/content/en/commands/hugo_gen_doc.md
2018-10-29 09:29:27 +01:00

1.1 KiB

date title slug url
2018-10-29 hugo gen doc hugo_gen_doc /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)
      --debug            debug output
      --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 - A collection of several useful generators.
Auto generated by spf13/cobra on 29-Oct-2018