2015-05-13 09:31:30 -04:00
|
|
|
---
|
2015-12-16 11:26:06 -05:00
|
|
|
date: 2015-12-16T09:24:56-07:00
|
2015-05-13 09:31:30 -04:00
|
|
|
title: "hugo"
|
|
|
|
slug: hugo
|
|
|
|
url: /commands/hugo/
|
|
|
|
---
|
|
|
|
## hugo
|
|
|
|
|
2015-05-21 07:30:01 -04:00
|
|
|
hugo builds your site
|
2015-05-13 09:31:30 -04:00
|
|
|
|
|
|
|
### Synopsis
|
|
|
|
|
|
|
|
|
2015-08-04 05:15:12 -04:00
|
|
|
hugo is the main command, used to build your Hugo site.
|
2015-05-13 09:31:30 -04:00
|
|
|
|
2015-08-04 05:15:12 -04:00
|
|
|
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/.
|
2015-05-13 09:31:30 -04:00
|
|
|
|
|
|
|
```
|
|
|
|
hugo
|
|
|
|
```
|
|
|
|
|
|
|
|
### Options
|
|
|
|
|
|
|
|
```
|
2015-09-09 01:29:04 -04:00
|
|
|
-b, --baseURL="": hostname (and path) to the root, e.g. http://spf13.com/
|
2015-08-04 05:15:12 -04:00
|
|
|
-D, --buildDrafts[=false]: include content marked as draft
|
|
|
|
-F, --buildFuture[=false]: include content with publishdate in the future
|
2015-05-13 09:31:30 -04:00
|
|
|
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
|
2015-11-25 17:11:16 -05:00
|
|
|
--canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL
|
2015-05-13 09:31:30 -04:00
|
|
|
--config="": config file (default is path/config.yaml|json|toml)
|
|
|
|
-d, --destination="": filesystem path to write files to
|
2015-08-04 05:15:12 -04:00
|
|
|
--disableRSS[=false]: Do not build RSS files
|
|
|
|
--disableSitemap[=false]: Do not build Sitemap file
|
2015-12-08 16:13:09 -05:00
|
|
|
--disableRobotsTXT[=false]: Do not build robots TXT file
|
2015-05-13 09:31:30 -04:00
|
|
|
--editor="": edit new content with this editor, if provided
|
2015-08-04 05:15:12 -04:00
|
|
|
--ignoreCache[=false]: Ignores the cache directory for reading but still writes to it
|
|
|
|
--log[=false]: Enable Logging
|
2015-05-13 09:31:30 -04:00
|
|
|
--logFile="": Log File path (if set, logging enabled automatically)
|
2015-08-04 05:15:12 -04:00
|
|
|
--noTimes[=false]: Don't sync modification time of files
|
|
|
|
--pluralizeListTitles[=true]: Pluralize titles in lists using inflect
|
|
|
|
--preserveTaxonomyNames[=false]: Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
|
2015-05-13 09:31:30 -04:00
|
|
|
-s, --source="": filesystem path to read files relative from
|
2015-08-04 05:15:12 -04:00
|
|
|
--stepAnalysis[=false]: display memory and timing of different steps of the program
|
2015-05-13 09:31:30 -04:00
|
|
|
-t, --theme="": theme to use (located in /themes/THEMENAME/)
|
2015-09-09 01:29:04 -04:00
|
|
|
--uglyURLs[=false]: if true, use /filename.html instead of /filename/
|
2015-08-04 05:15:12 -04:00
|
|
|
-v, --verbose[=false]: verbose output
|
|
|
|
--verboseLog[=false]: verbose logging
|
|
|
|
-w, --watch[=false]: watch filesystem for changes and recreate as needed
|
2015-05-13 09:31:30 -04:00
|
|
|
```
|
|
|
|
|
|
|
|
### SEE ALSO
|
2015-08-04 05:15:12 -04:00
|
|
|
* [hugo benchmark](/commands/hugo_benchmark/) - Benchmark hugo by building a site a number of times.
|
2015-05-13 09:31:30 -04:00
|
|
|
* [hugo check](/commands/hugo_check/) - Check content in the source directory
|
|
|
|
* [hugo config](/commands/hugo_config/) - Print the site configuration
|
2015-08-04 05:15:12 -04:00
|
|
|
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
|
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.
|
2015-05-13 09:31:30 -04:00
|
|
|
* [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
|
2015-05-13 09:31:30 -04:00
|
|
|
* [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
|
|
|
|
|
2015-12-16 11:26:06 -05:00
|
|
|
###### Auto generated by spf13/cobra on 16-Dec-2015
|