github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-12-25 06:51:42 +00:00
Code Issues Projects Releases Packages Wiki Activity
hugo/docs/content/commands/hugo_gen_doc.md
Bjørn Erik Pedersen 3631fd2f0e docs: Regenerate commands doc
2017-02-25 10:03:28 +01:00

1.1 KiB
Raw Blame History

date title slug url
2017-02-25T10:01:37+01:00 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

Options

      --dir string   the directory to write the doc. (default "/tmp/hugodoc/")

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 - A collection of several useful generators.
Auto generated by spf13/cobra on 25-Feb-2017