golda gen doc

golda gen doc

Generate Markdown documentation for the Golda CLI

Synopsis

Generate Markdown documentation for the Golda CLI. This command is, mostly, used to create up-to-date documentation of Golda’s command-line interface for https://golda.personaltechhelp.com.

It creates one Markdown file per command with front matter suitable
for rendering in Golda.

golda gen doc [flags] [args]

Options

      --dir string   the directory to write the doc. (default "/tmp/goldadoc/")
  -h, --help         help for doc

Options inherited from parent commands

      --clock string               set the clock used by Golda, e.g. --clock 2021-11-06T22:30:00.00+09:00
      --config string              config file (default is golda.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                don't create .hugo_build.lock file
      --quiet                      build in quiet mode
  -M, --renderToMemory             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

• golda gen - Generate documentation and syntax highlighting styles