mirror of
https://github.com/gohugoio/hugo.git
synced 2026-08-24 15:28:54 +00:00
c23d97904f
1f8ddb8a52 content: clarify resources front matter key descriptions e064ab8528 content: Add deprecation badges to module config page 727ca5563a github: Add push trigger to lint workflow 64dd5c9886 content: Fix typo c5bc6b6515 github: Fix lint workflow faec0c3a0a github: Combine linting actions into a single workflow 06112aeaf2 theme: Miscellaneous template edits 75d4902270 theme: Format templates with gotmplfmt fec2e2a67e content: Document that the language code in a file name must be lowercase 9dbd841ba6 content: Document the src attribute in the Page Resources metadata reference fd3ffef985 content: Fix "build from source" instructions for Windows af4c9cd4d7 content: Miscellaneous edits 408d8b2f0a content: Miscellaneous edits e8804afe6e content: Fix typo d98276be30 content: Updates for v0.161.0 01b1f8fa12 content: Note merge limitation for slice configuration values d2b18f0c8d content: Document page matcher usage for cascading values 45e5bd9ab3 content: Update Cloudflare Worker host/deploy guide b83726b89a content: Document fallback rendering for fenced code blocks 8f1eeb42bc content: Update reference for source code shortcode e8da56303b content: Add gotmplfmt to list of VS Code extensions 950fabbfd6 content: Update FAQ on feature availability error 6411146d24 content: Update quick start guide 38cc39fd51 content: Add Hugo Shortcodes to list of VS Code extensions 72d98b107b content: Misc updates to get validators to pass 9fb0e1ca35 Add a paragraph about sec boundaries e6abf5644f content: Improve syntax highlighting documentation c06193bd1a content: Update go-i18n package reference ce58fef945 Hugo 0.161.1 c7e0f63385 content: Fix package references 7f15fb3bf9 data: Regen docshelper 7483d53b55 Update HUGO_VERSION to 0.161.0 c4abcdb45f security: Add a bullet point about "pragmatic defaults" 3cd7492862 content: Improve explanation of mount removal in module configurations 4099f07bb9 content: Update GitHub Pages workflow example a6c9853a58 content: Fix typo e6f79a938b Update netlify.toml abda3d6659 content: Update Action versions in GitHub Pages workflow example 55dd288fa9 content: Add GitCMS to front-ends tools list 21081f6d49 content: Remove outdated new-in badges b2ec263884 content: Update version references 825e0b8ea9 One more CSS var adjustment 85f95a899b Adjust css.Build var docs a little df48288002 content: Updates for v0.160.0 a82a9b9797 Update HUGO_VERSION to 0.160.0 1155747dc4 content: Improve CSS processing feature description f6ce893974 content: Add css.Build to features 67b8ed1198 content: Fix typos 0f62a67863 content: Fix typo dbb42aed4a content: Document the deploy edition 549f30f933 content: De-emphasize references to the extended edition 8f5c9782d4 content: Add Pages CMS to front-ends documentation b2bfc3af48 Update HUGO_VERSION to 0.159.2 3793156fc5 content: Fix typos bacd4824ef content: Specify function namespace in example 7f2dc0d40a Regen docs.yml 65a851f731 Update HUGO_VERSION to 0.159.1 ce05fe3fc0 content: Adjust variable references in build script examples 8a04f9fe64 content: Improve hosting build script examples 67962ce05c content: Link to Codeberg Pages 404 handling fd248f57ed content: Identify esbuild as the foundation for build functions 62f02879fd content: Remove outdated content 553c407f9e content: Miscellaneous corrections 77e2cad088 content: Add new-in badge for usePackageJSON 0746e1e621 Add a page on using npm dependencies in Hugo Modules 8824850f5c Update HUGO_VERSION to 0.159.0 git-subtree-dir: docs git-subtree-split: 1f8ddb8a5230518f07c50b4b03cba3cae21081c4
98 lines
5.4 KiB
Markdown
98 lines
5.4 KiB
Markdown
---
|
|
title: "hugo server"
|
|
slug: hugo_server
|
|
url: /commands/hugo_server/
|
|
---
|
|
## hugo server
|
|
|
|
Start the embedded web server
|
|
|
|
### Synopsis
|
|
|
|
Hugo provides its own webserver which builds and serves the project.
|
|
While hugo server is high performance, it is a webserver with limited options.
|
|
|
|
The `hugo server` command will by default write and serve files from disk, but
|
|
you can render to memory by using the `--renderToMemory` flag. This can be
|
|
faster in some cases, but it will consume more memory.
|
|
|
|
By default hugo will also watch your files for any changes you make and
|
|
automatically rebuild the project. It will then live reload any open browser pages
|
|
and push the latest content to them. As most Hugo projects are built in a fraction
|
|
of a second, you will be able to save and see your changes nearly instantly.
|
|
|
|
```
|
|
hugo server [command] [flags]
|
|
```
|
|
|
|
### Options
|
|
|
|
```
|
|
--appendPort append port to baseURL (default true)
|
|
-b, --baseURL string hostname (and path) to the root, e.g. https://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
|
|
--cleanDestinationDir remove files from destination not found in static directories
|
|
-c, --contentDir string filesystem path to content directory
|
|
--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 ignore the configured file caches
|
|
-l, --layoutDir string filesystem path to layout directory
|
|
--liveReloadPort int port for live reloading (i.e. 443 in HTTPS proxy situations) (default -1)
|
|
--minify minify any supported output format (HTML, XML etc.)
|
|
-N, --navigateToChanged navigate to changed content file on live browser reload
|
|
--noChmod don't sync permission mode of files
|
|
--noHTTPCache disable browser caching of pages served by the embedded web server
|
|
--noTimes don't sync modification time of files
|
|
-O, --openBrowser open the project in a browser after server startup
|
|
--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)
|
|
--pprof enable the pprof server (port 8080)
|
|
--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.
|
|
--renderSegments strings named segments to render (configured in the segments config)
|
|
--renderStaticToDisk serve static files from disk and dynamic files from memory
|
|
--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/)
|
|
--tlsAuto generate and use locally-trusted certificates.
|
|
--tlsCertFile string path to TLS certificate file
|
|
--tlsKeyFile string path to TLS key file
|
|
--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
|
|
|
|
```
|
|
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
|
|
--config string config file (default is hugo.yaml|json|toml)
|
|
--configDir string config dir (default "config")
|
|
-d, --destination string filesystem path to write files to
|
|
-e, --environment string build environment
|
|
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
|
|
--logLevel string log level (debug|info|warn|error)
|
|
--noBuildLock don't create .hugo_build.lock file
|
|
--quiet build in quiet mode
|
|
-M, --renderToMemory render to memory (mostly useful when running the server)
|
|
-s, --source string filesystem path to read files relative from
|
|
--themesDir string filesystem path to themes directory
|
|
```
|
|
|
|
### SEE ALSO
|
|
|
|
* [hugo](/commands/hugo/) - Build your project
|
|
* [hugo server trust](/commands/hugo_server_trust/) - Install the local CA in the system trust store
|