github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-14 20:37:55 -05:00
Code Issues Projects Releases Packages Wiki Activity
hugo/content/commands/hugo_server.md
Bjørn Erik Pedersen ecf5e081b5 Squashed 'docs/' changes from 000ab7c42..4628b9ec2 
4628b9ec2 commands: Regen CLI doc
2525f2ed0 data: Regenerate docs helper
6f5a0eb19 Add Hugo 0.30 poster image
72c3fac9e Merge branch 'chroma-next2' into next
364973d3f Fix typo in syntax highlighting.
ce10cc02e Update Chroma highlighting docs
9dcc4d4dd Update robots.md
1e64cb483 Rename title of cross references' page
d6dfbbc51 Add warning about MMark and TOCs
e8d259d32 Fix link to subsection in page
6adead19d Merge commit '040d8d2833c26c53cf9f0e035910821ed50e3863'
040d8d283 Squashed 'themes/gohugoioTheme/' changes from cdaa89c8..6b632895
bde95d890 Add Atlas starter kit
fc40d078d Remove page arg from examples of relref shortcode
c578620b5 Remove page arg from examples of ref shortcode
ee81931a4 Remove delimiters in YAML and TOML config examples
62d7b269f Clarify that .Lastmod automatically uses .GitInfo.AuthorDate (#226)

git-subtree-dir: docs
git-subtree-split: 4628b9ec2c52df4de673a4d6b9621a65d8e8f5a4
2017-10-15 10:20:55 +02:00

4.7 KiB
Raw Blame History

date title slug url
2017-10-15T10:19:48+02:00 hugo server hugo_server /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/
      --canonifyURLs            if true, all relative URLs will be canonicalized using baseURL
      --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
      --disable404              do not render 404 page
      --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
      --disableRSS              do not build RSS files
      --disableSitemap          do not build Sitemap file
      --enableGitInfo           add Git revision, date and author info to the pages
      --forceSyncStatic         copy all files when static is changed.
  -h, --help                    help for server
      --i18n-warnings           print missing translations
      --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
      --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
      --pluralizeListTitles     pluralize titles in lists using inflect (default true)
  -p, --port int                port on which the server will listen (default 1313)
      --preserveTaxonomyNames   preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
      --renderToDisk            render to Destination path (default is render to memory & serve from there)
  -s, --source string           filesystem path to read files relative from
      --stepAnalysis            display memory and timing of different steps of the program
      --templateMetrics         display metrics about template executions
      --templateMetricsHints    calculate some improvement hints when combined with --templateMetrics
  -t, --theme string            theme to use (located in /themes/THEMENAME/)
      --themesDir string        filesystem path to themes directory
      --uglyURLs                if true, use /filename.html instead of /filename/
  -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)
      --debug            debug output
      --log              enable Logging
      --logFile string   log File path (if set, logging enabled automatically)
      --quiet            build in quiet mode
  -v, --verbose          verbose output
      --verboseLog       verbose logging

SEE ALSO

  • hugo - hugo builds your site
Auto generated by spf13/cobra on 15-Oct-2017