mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
d706529720
a393f4cf4 Add a Spellcheck GitHub Action and config 8b6b1c381 netlify: Bump to Hugo 0.93.3 84515c183 Delete deployment-with-nanobox.md dd45f9899 Fix typos in docs e69de81a9 Update build-options.md 7745b7891 netlify: Hubo 0.93.2 037d63364 Clarify GitHub Pages Branches 94660c34b add missing %s 325de15e2 fix link to latest release note since the release notes were moved to GitHub: https://gohugo.io/news/no-more-releasenotes-here/ dbff41d01 Update introduction.md 0ecd627f7 netlify: Hugo 0.93.1 a74e16582 Update diagrams.md 33e310956 Add Goat example to test styling fa0100a5b Update diagrams.md 64ac75367 Adjust diagram docs f1d600044 Update theme 95bedff1a netlify: Bump to Hugo 0.93.0 849a8437f Merge commit 'c1398b91a9f4c67876b31feb67516b252e654d3c' c0c60c43c docs: Regenerate docs helper 2c63fe518 cod: Regen CLI docs f33ba4e5a CodeblockContext method renames 979b47968 Move the Goat template to the correct place 2df37e9e8 Add Markdown diagrams and render hooks for code blocks bd8037d43 Allow images to be cropped without being resized 8b2af4b49 modules: Add modules.Workspace config for Go 1.18 46b99dea1 Add --printUnusedTemplates 1285302c9 commands: Rename --i18n-warnings to printI18nWarnings dea2242c6 commands: Rename --path-warnings, --print-men to --printPathWarnings, --printMemoryUsage db782ea46 deps: Update github.com/alecthomas/chroma v0.9.4 => v0.10.0 git-subtree-dir: docs git-subtree-split: a393f4cf43829011e96d109de2f039a9b05b2d16
95 lines
5 KiB
Markdown
95 lines
5 KiB
Markdown
---
|
|
title: "hugo server"
|
|
slug: hugo_server
|
|
url: /commands/hugo_server/
|
|
---
|
|
## hugo server
|
|
|
|
A high performance webserver
|
|
|
|
### Synopsis
|
|
|
|
Hugo provides its own webserver which builds and serves the site.
|
|
While hugo server is high performance, it is a webserver with limited options.
|
|
Many run it in production, but the standard behavior is for people to use it
|
|
in development and use a more full featured server such as Nginx or Caddy.
|
|
|
|
'hugo server' will avoid writing the rendered and served content to disk,
|
|
preferring to store it in memory.
|
|
|
|
By default hugo will also watch your files for any changes you make and
|
|
automatically rebuild the site. It will then live reload any open browser pages
|
|
and push the latest content to them. As most Hugo sites are built in a fraction
|
|
of a second, you will be able to save and see your changes nearly instantly.
|
|
|
|
```
|
|
hugo server [flags]
|
|
```
|
|
|
|
### Options
|
|
|
|
```
|
|
--appendPort append port to baseURL (default true)
|
|
-b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/
|
|
--bind string interface to which the server will bind (default "127.0.0.1")
|
|
-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
|
|
-c, --contentDir string filesystem path to content directory
|
|
-d, --destination string filesystem path to write files to
|
|
--disableBrowserError do not show build errors in the browser
|
|
--disableFastRender enables full re-renders on changes
|
|
--disableKinds strings disable different kind of pages (home, RSS etc.)
|
|
--disableLiveReload watch without enabling live browser reload on rebuild
|
|
--enableGitInfo add Git revision, date, author, and CODEOWNERS 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 server
|
|
--ignoreCache ignores the cache directory
|
|
-l, --layoutDir string filesystem path to layout directory
|
|
--liveReloadPort int port for live reloading (i.e. 443 in HTTPS proxy situations) (default -1)
|
|
--meminterval string interval to poll memory usage (requires --memstats), valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". (default "100ms")
|
|
--memstats string log memory usage to this file
|
|
--minify minify any supported output format (HTML, XML etc.)
|
|
--navigateToChanged navigate to changed content file on live browser reload
|
|
--noChmod don't sync permission mode of files
|
|
--noHTTPCache prevent HTTP caching
|
|
--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
|
|
-p, --port int port on which the server will listen (default 1313)
|
|
--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.
|
|
--renderToDisk render to Destination path (default is render to memory & serve from there)
|
|
--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/)
|
|
--trace file write trace to file (not useful in general)
|
|
-w, --watch watch filesystem for changes and recreate as needed (default true)
|
|
```
|
|
|
|
### Options inherited from parent commands
|
|
|
|
```
|
|
--config string config file (default is path/config.yaml|json|toml)
|
|
--configDir string config dir (default "config")
|
|
--debug debug output
|
|
-e, --environment string build environment
|
|
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
|
|
--log enable Logging
|
|
--logFile string log File path (if set, logging enabled automatically)
|
|
--quiet build in quiet mode
|
|
-s, --source string filesystem path to read files relative from
|
|
--themesDir string filesystem path to themes directory
|
|
-v, --verbose verbose output
|
|
--verboseLog verbose logging
|
|
```
|
|
|
|
### SEE ALSO
|
|
|
|
* [hugo](/commands/hugo/) - hugo builds your site
|
|
|