hugo/docs/content/en/commands/hugo.md

78 lines
3.7 KiB
Markdown
Raw Normal View History

---
2018-10-29 08:29:27 +00:00
date: 2018-10-29
title: "hugo"
slug: hugo
url: /commands/hugo/
---
## hugo
hugo builds your site
### Synopsis
hugo 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 http://gohugo.io/.
```
hugo [flags]
```
### Options
```
Squashed 'docs/' changes from e5e98b950..084804447 084804447 Update shortcode-templates.md c01b02434 Correct misspelling of 'default' 52a831cca Added missing parenthesis 59e8e660a Fix spelling typos 29ad53c9c Yes, HTML is a valid content format c6b193c6f Update shortcode-templates.md 1f2846e6d Fix typo in output format README 5882f7a4c Fix typo a90a00bb0 Update multilingual.md 62bf0f184 Documentation for Open Graph & Twitter Cards f4d624da3 Document "images", "videos", etc. in front-matter 6a85b5df1 Document anchorize and Resources.Content 04c8a5b0e Fix minor typo in 0.49.2 release note dbe77e948 Release 0.49.2 ea6c9658e Merge branch 'temp492' 85c45b725 Merge branch 'release-0.49.2' 7ad1fba29 releaser: Prepare repository for 0.50-DEV b25bcc3f2 releaser: Add release notes to /docs for release of 0.49.2 78b751b91 releaser: Bump versions for release of 0.49.2 e3f09762c Release 0.49.1 bd5b94558 Merge branch 'temp491' 0007e0661 Merge branch 'release-0.49.1' 74d2f3a6f releaser: Prepare repository for 0.50-DEV bbee7e9d3 releaser: Add release notes to /docs for release of 0.49.1 ae40c89c7 releaser: Bump versions for release of 0.49.1 11079fb48 Add draft statement to FAQ 069b9472f Addin Hokus CMS to frontends list. 6e8850670 Add MediaType docs f3ca6209a Add `languageName` to configuration fd1cde5ea tpl: Add a delimiter parameter to lang.NumFmt c620ff78a Update doc to use proper variable 7317c339a add tools->hugo-elasticsearch description to docs d758ef94a hugolib: Introduce Page.NextPage and Page.PrevPage 9c93ac031 Update installing.md 7c0b5b7f5 Use ISO 639-1 code for examples 9a9e40ba8 Fix spelling 9a6216c18 Hugo 0.49 55aa91185 Merge branch 'temp49' e0a36421e releaser: Prepare repository for 0.50-DEV c07b3b385 releaser: Add release notes to /docs for release of 0.49 c1175a12a releaser: Bump versions for release of 0.49 2966f6254 docs: Document directory based archetypes 73dcd02ed Add showcase archetype folder 0a55ad11b docs: Regenerate CLI docs e09866c2d docs: Document group ef986358a Merge commit '807c551922707fc5ae0eb26e8f01638c0c63fdb3' 681f14fc9 tpl/collections: Allow first function to return an empty slice f6dcc93bc docs: Add docs for append aae528ca3 Merge commit '13e64d72763bf8d6d92d4cdfc15ed45ee9debfab' 02b62294c tpl/strings: Add strings.FirstUpper bf3e61ba3 hugolib: Do not FirstUpper taxonomy titles git-subtree-dir: docs git-subtree-split: 084804447402ab99b51bf49f0da809bee8c16339
2018-10-29 08:19:20 +00:00
-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
--config string config file (default is path/config.yaml|json|toml)
-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 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 hugo
--i18n-warnings print missing translations
--ignoreCache ignores the cache directory
-l, --layoutDir string filesystem path to layout directory
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--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
--quiet build in quiet mode
--renderToMemory render to memory (only useful for benchmark testing)
-s, --source string filesystem path to read files relative from
--stepAnalysis display memory and timing of different steps of the program
--templateMetrics display metrics about template executions
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics
-t, --theme string theme to use (located in /themes/THEMENAME/)
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
-w, --watch watch filesystem for changes and recreate as needed
```
### SEE ALSO
* [hugo benchmark](/commands/hugo_benchmark/) - Benchmark Hugo by building a site a number of times.
* [hugo check](/commands/hugo_check/) - Contains some verification checks
* [hugo config](/commands/hugo_config/) - Print the site configuration
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
* [hugo env](/commands/hugo_env/) - Print Hugo version and environment info
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
* [hugo import](/commands/hugo_import/) - Import your site from others.
* [hugo list](/commands/hugo_list/) - Listing out various types of content
* [hugo new](/commands/hugo_new/) - Create new content for your site
* [hugo server](/commands/hugo_server/) - A high performance webserver
* [hugo version](/commands/hugo_version/) - Print the version number of Hugo
2018-10-29 08:29:27 +00:00
###### Auto generated by spf13/cobra on 29-Oct-2018