hugo(1) - f34

1HUGO(1)                           Hugo Manual                          HUGO(1)
2
3
4

NAME

6       hugo - hugo builds your site
7
8
9

SYNOPSIS

11       hugo [flags]
12
13
14

DESCRIPTION

16       hugo is the main command, used to build your Hugo site.
17
18
19       Hugo  is  a  Fast and Flexible Static Site Generator built with love by
20       spf13 and friends in Go.
21
22
23       Complete documentation is available at http://gohugo.io/.
24
25
26

OPTIONS

28       -b,  --baseURL=""       hostname  (and  path)   to   the   root,   e.g.
29       http://spf13.com/
30
31
32       -D, --buildDrafts[=false]      include content marked as draft
33
34
35       -E, --buildExpired[=false]      include expired content
36
37
38       -F,  --buildFuture[=false]      include content with publishdate in the
39       future
40
41
42       --cacheDir=""       filesystem  path  to  cache  directory.   Defaults:
43       $TMPDIR/hugo_cache/
44
45
46       --cleanDestinationDir[=false]       remove  files  from destination not
47       found in static directories
48
49
50       --config=""      config file (default is path/config.yaml|json|toml)
51
52
53       --configDir="config"      config dir
54
55
56       -c, --contentDir=""      filesystem path to content directory
57
58
59       --debug[=false]      debug output
60
61
62       -d, --destination=""      filesystem path to write files to
63
64
65       --disableKinds=[]      disable different kind of pages (home, RSS etc.)
66
67
68       --enableGitInfo[=false]      add Git revision, date and author info  to
69       the pages
70
71
72       -e, --environment=""      build environment
73
74
75       --forceSyncStatic[=false]      copy all files when static is changed.
76
77
78       --gc[=false]      enable to run some cleanup tasks (remove unused cache
79       files) after the build
80
81
82       -h, --help[=false]      help for hugo
83
84
85       --i18n-warnings[=false]      print missing translations
86
87
88       --ignoreCache[=false]      ignores the cache directory
89
90
91       --ignoreVendor[=false]      ignores any _vendor directory
92
93
94       --ignoreVendorPaths=""      ignores any _vendor for module paths match‐
95       ing the given Glob pattern
96
97
98       -l, --layoutDir=""      filesystem path to layout directory
99
100
101       --log[=false]      enable Logging
102
103
104       --logFile=""      log File path (if set, logging enabled automatically)
105
106
107       --minify[=false]       minify  any  supported  output format (HTML, XML
108       etc.)
109
110
111       --noChmod[=false]      don't sync permission mode of files
112
113
114       --noTimes[=false]      don't sync modification time of files
115
116
117       --path-warnings[=false]      print warnings on duplicate  target  paths
118       etc.
119
120
121       --print-mem[=false]      print memory usage to screen at intervals
122
123
124       --quiet[=false]      build in quiet mode
125
126
127       --renderToMemory[=false]       render to memory (only useful for bench‐
128       mark testing)
129
130
131       -s, --source=""      filesystem path to read files relative from
132
133
134       --templateMetrics[=false]      display metrics  about  template  execu‐
135       tions
136
137
138       --templateMetricsHints[=false]       calculate  some  improvement hints
139       when combined with --templateMetrics
140
141
142       -t, --theme=[]      themes to use (located in /themes/THEMENAME/)
143
144
145       --themesDir=""      filesystem path to themes directory
146
147
148       --trace=""      write trace to file (not useful in general)
149
150
151       -v, --verbose[=false]      verbose output
152
153
154       --verboseLog[=false]      verbose logging
155
156
157       -w, --watch[=false]      watch filesystem for changes and  recreate  as
158       needed
159
160
161

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

SEE ALSO