diff options
author | Bjørn Erik Pedersen <[email protected]> | 2024-09-30 09:11:24 +0200 |
---|---|---|
committer | Bjørn Erik Pedersen <[email protected]> | 2024-09-30 10:36:29 +0200 |
commit | 0450d69fc6ec2e3369d106547b6e49c539081cdc (patch) | |
tree | faeab438782410d7d02d29b60ea3b35ca8e4fdbb /docs | |
parent | 1158e6307212fd3ff96f29db0baf79463e0c031e (diff) | |
download | hugo-0450d69fc6ec2e3369d106547b6e49c539081cdc.tar.gz hugo-0450d69fc6ec2e3369d106547b6e49c539081cdc.zip |
commands: Add "hugo build" as an alias for "hugo"
Closes #11391
Diffstat (limited to 'docs')
-rw-r--r-- | docs/content/en/commands/hugo.md | 1 | ||||
-rw-r--r-- | docs/content/en/commands/hugo_build.md | 74 |
2 files changed, 75 insertions, 0 deletions
diff --git a/docs/content/en/commands/hugo.md b/docs/content/en/commands/hugo.md index cfbe66053..badd6d7ea 100644 --- a/docs/content/en/commands/hugo.md +++ b/docs/content/en/commands/hugo.md @@ -70,6 +70,7 @@ hugo [flags] ### SEE ALSO +* [hugo build](/commands/hugo_build/) - build builds your site * [hugo completion](/commands/hugo_completion/) - Generate the autocompletion script for the specified shell * [hugo config](/commands/hugo_config/) - Print the site configuration * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats diff --git a/docs/content/en/commands/hugo_build.md b/docs/content/en/commands/hugo_build.md new file mode 100644 index 000000000..72686cb9b --- /dev/null +++ b/docs/content/en/commands/hugo_build.md @@ -0,0 +1,74 @@ +--- +title: "hugo build" +slug: hugo_build +url: /commands/hugo_build/ +--- +## hugo build + +build builds your site + +### Synopsis + +build is the main command, used to build your Hugo site. + +Hugo is a Fast and Flexible Static Site Generator +built with love by spf13 and friends in Go. + +Complete documentation is available at https://gohugo.io/. + +``` +hugo build [flags] +``` + +### Options + +``` + -b, --baseURL string hostname (and path) to the root, e.g. https://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 + --cleanDestinationDir remove files from destination not found in static directories + --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 + --config string config file (default is hugo.yaml|json|toml) + --configDir string config dir (default "config") + -c, --contentDir string filesystem path to content directory + --debug debug output + -d, --destination string filesystem path to write files to + --disableKinds strings disable different kind of pages (home, RSS etc.) + --enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages + -e, --environment string build environment + --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 build + --ignoreCache ignores the cache directory + --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern + -l, --layoutDir string filesystem path to layout directory + --logLevel string log level (debug|info|warn|error) + --minify minify any supported output format (HTML, XML etc.) + --noBuildLock don't create .hugo_build.lock file + --noChmod don't sync permission mode of files + --noTimes don't sync modification time of files + --panicOnWarning panic on first WARNING log + --poll string set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes + --printI18nWarnings print missing translations + --printMemoryUsage print memory usage to screen at intervals + --printPathWarnings print warnings on duplicate target paths etc. + --printUnusedTemplates print warnings on unused templates. + --quiet build in quiet mode + --renderSegments strings named segments to render (configured in the segments config) + -M, --renderToMemory render to memory (mostly useful when running the server) + -s, --source string filesystem path to read files relative from + --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/) + --themesDir string filesystem path to themes directory + --trace file write trace to file (not useful in general) + -v, --verbose verbose output + -w, --watch watch filesystem for changes and recreate as needed +``` + +### SEE ALSO + +* [hugo](/commands/hugo/) - hugo builds your site + |