hugo gen doc

hugo gen doc

Generate Markdown documentation for the Hugo CLI.

概要

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]

オプション

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

Options inherited from parent commands

      --clock string               Hugo が用いる日時を指定します。--clock 2021-11-06T22:30:00.00+09:00
      --config string              設定ファイルを指定します。 (デフォルトは hugo.yaml|json|toml)
      --configDir string           設定ディレクトリを指定します。 (デフォルトは "config")
      --debug                      デバッグ出力を行います。
  -d, --destination string         ファイル出力を行うパスを指定します。
  -e, --environment string         ビルド環境を指定します。
      --ignoreVendorPaths string   指定 Glob パターンにマッチするモジュールパスを _vendor として無視します。
      --logLevel string            ログレベルを指定します。 (debug|info|warn|error)
      --quiet                      出力抑制モード (quite mode) によりビルドを行います。
  -M, --renderToMemory             メモリーにレンダーします。 (サーバー起動時に有用)
  -s, --source string              ファイル入力元を相対パスで指定します。
      --themesDir string           テーマディレクトリのパスを指定します。
  -v, --verbose                    詳細出力を行います。

SEE ALSO

• hugo gen - A collection of several useful generators.