hugo/docs/content/commands/hugo.md

78 lines
3.7 KiB
Markdown
Raw Normal View History

---
2016-12-20 03:39:12 -05:00
date: 2016-12-20T09:38:40+01:00
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
```
### Options
```
2016-04-09 17:01:55 -04:00
-b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/
-D, --buildDrafts include content marked as draft
2016-06-22 08:03:18 -04:00
-E, --buildExpired include expired content
2016-04-09 17:01:55 -04:00
-F, --buildFuture include content with publishdate in the future
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--canonifyURLs if true, all relative URLs will be canonicalized using baseURL
--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
-d, --destination string filesystem path to write files to
2016-06-22 08:03:18 -04:00
--disable404 Do not render 404 page
2016-04-09 17:01:55 -04:00
--disableRSS Do not build RSS files
--disableSitemap Do not build Sitemap file
2016-12-20 03:39:12 -05:00
--enableGitInfo Add Git revision, date and author info to the pages
2016-04-09 17:01:55 -04:00
--forceSyncStatic Copy all files when static is changed.
2016-10-05 04:23:45 -04:00
--i18n-warnings Print missing translations
2016-06-22 08:03:18 -04:00
--ignoreCache Ignores the cache directory
2016-04-09 17:01:55 -04:00
-l, --layoutDir string filesystem path to layout directory
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
--noChmod Don't sync permission mode of files
2016-04-09 17:01:55 -04:00
--noTimes Don't sync modification time of files
--pluralizeListTitles Pluralize titles in lists using inflect (default true)
--preserveTaxonomyNames Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
2016-12-20 03:39:12 -05:00
--quiet build in quiet mode
2016-04-09 17:01:55 -04:00
--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
-t, --theme string theme to use (located in /themes/THEMENAME/)
--uglyURLs if true, use /filename.html instead of /filename/
-v, --verbose verbose output
--verboseLog verbose logging
-w, --watch watch filesystem for changes and recreate as needed
```
### SEE ALSO
2016-06-22 08:03:18 -04:00
* [hugo benchmark](/commands/hugo_benchmark/) - Benchmark Hugo by building a site a number of times.
2016-12-20 03:39:12 -05:00
* [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
2016-10-05 04:23:45 -04:00
* [hugo env](/commands/hugo_env/) - Print Hugo version and environment info
2015-11-25 17:11:16 -05:00
* [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
2015-11-25 17:11:16 -05:00
* [hugo server](/commands/hugo_server/) - A high performance webserver
* [hugo undraft](/commands/hugo_undraft/) - Undraft changes the content's draft status from 'True' to 'False'
* [hugo version](/commands/hugo_version/) - Print the version number of Hugo
2016-12-20 03:39:12 -05:00
###### Auto generated by spf13/cobra on 20-Dec-2016