docs: Regenerate CLI docs

2025-08-17 21:01:26 +02:00 · 2019-07-24 09:40:41 +02:00
parent 23adc0c2d9
commit 215d2ed883
34 changed files with 856 additions and 271 deletions
--- a/docs/content/en/commands/hugo_mod.md
+++ b/docs/content/en/commands/hugo_mod.md
@@ -0,0 +1,83 @@
+---
+date: 2019-07-24
+title: "hugo mod"
+slug: hugo_mod
+url: /commands/hugo_mod/
+---
+## hugo mod
+
+Various Hugo Modules helpers.
+
+### Synopsis
+
+Various helpers to help manage the modules in your project's dependency graph.
+
+Most operations here requires a Go version installed on your system (>= Go 1.12) and the relevant VCS client (typically Git).
+This is not needed if you only operate on modules inside /themes or if you have vendored them via "hugo mod vendor".
+
+
+Note that Hugo will always start out by resolving the components defined in the site
+configuration, provided by a _vendor directory (if no --ignoreVendor flag provided),
+Go Modules, or a folder inside the themes directory, in that order.
+
+See https://gohugo.io/hugo-modules/ for more information.
+
+
+
+### Options
+
+```
+  -b, --baseURL string         hostname (and path) to the root, e.g. http://spf13.com/
+  -D, --buildDrafts            include content marked as draft
+  -E, --buildExpired           include expired content
+  -F, --buildFuture            include content with publishdate in the future
+      --cacheDir string        filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
+      --cleanDestinationDir    remove files from destination not found in static directories
+  -c, --contentDir string      filesystem path to content directory
+  -d, --destination string     filesystem path to write files to
+      --disableKinds strings   disable different kind of pages (home, RSS etc.)
+      --enableGitInfo          add Git revision, date and author info to the pages
+      --forceSyncStatic        copy all files when static is changed.
+      --gc                     enable to run some cleanup tasks (remove unused cache files) after the build
+  -h, --help                   help for mod
+      --i18n-warnings          print missing translations
+      --ignoreCache            ignores the cache directory
+  -l, --layoutDir string       filesystem path to layout directory
+      --minify                 minify any supported output format (HTML, XML etc.)
+      --noChmod                don't sync permission mode of files
+      --noTimes                don't sync modification time of files
+      --path-warnings          print warnings on duplicate target paths etc.
+      --templateMetrics        display metrics about template executions
+      --templateMetricsHints   calculate some improvement hints when combined with --templateMetrics
+  -t, --theme strings          themes to use (located in /themes/THEMENAME/)
+      --trace file             write trace to file (not useful in general)
+```
+
+### Options inherited from parent commands
+
+```
+      --config string        config file (default is path/config.yaml|json|toml)
+      --configDir string     config dir (default "config")
+      --debug                debug output
+  -e, --environment string   build environment
+      --ignoreVendor         ignores any _vendor directory
+      --log                  enable Logging
+      --logFile string       log File path (if set, logging enabled automatically)
+      --quiet                build in quiet mode
+  -s, --source string        filesystem path to read files relative from
+      --themesDir string     filesystem path to themes directory
+  -v, --verbose              verbose output
+      --verboseLog           verbose logging
+```
+
+### SEE ALSO
+
+* [hugo](/commands/hugo/)	 - hugo builds your site
+* [hugo mod clean](/commands/hugo_mod_clean/)	 - Delete the entire Hugo Module cache.
+* [hugo mod get](/commands/hugo_mod_get/)	 - Resolves dependencies in your current Hugo Project.
+* [hugo mod graph](/commands/hugo_mod_graph/)	 - Print a module dependency graph.
+* [hugo mod init](/commands/hugo_mod_init/)	 - Initialize this project as a Hugo Module.
+* [hugo mod tidy](/commands/hugo_mod_tidy/)	 - Remove unused entries in go.mod and go.sum.
+* [hugo mod vendor](/commands/hugo_mod_vendor/)	 - Vendor all module dependencies into the _vendor directory.
+
+###### Auto generated by spf13/cobra on 24-Jul-2019