github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-12-28 13:10:48 +00:00
Code Issues Projects Releases Packages Wiki Activity
hugo/docs/content/overview/usage.md
Anthony Fok ca7007bf26 Minor proofreading corrections to Hugo docs 
- Add backticks and commas where necessary
- Remove some trailing whitespace
- Add front matter example in TOML
- Fix typo in one of the tags in Showcase
- Add 多说 (Duoshuo) as an alternative to Disqus
- Use internal links (i.e. without gohugo.io) where possible
- Use a colon to set off an example
- Change "it's" to "its" where appropriate
- Use typographical (i.e. curly) apostrophe on the front page
  where appropriate
- Capitalize "Github" as "GitHub"
2014-10-15 12:18:20 -04:00

3 KiB
Raw Blame History

aliases date menu next notoc prev title weight
/doc/usage/
2013-07-01
main
parent
getting started
/overview/configuration true /overview/installing Using Hugo 30

Make sure either hugo is in your path or provide a path to it.

$ hugo help
A Fast and Flexible Static Site Generator
built with love by spf13 and friends in Go.

Complete documentation is available at http://gohugo.io

Usage:
  hugo [flags]
  hugo [command]

Available Commands:
  server                    Hugo runs its own webserver to render the files
  version                   Print the version number of Hugo
  check                     Check content in the source directory
  benchmark                 Benchmark hugo by building a site a number of times
  new [path]                Create new content for your site
  help [command]            Help about any command

 Available Flags:
  -b, --baseUrl="": hostname (and path) to the root eg. http://spf13.com/
  -D, --buildDrafts=false: build content marked as draft
  -F, --buildFuture=false: build content with PublishDate in the future
      --config="": config file (default is path/config.yaml|json|toml)
  -d, --destination="": filesystem path to write files to
      --disableRSS=false: Do not build RSS files
      --disableSitemap=false: Do not build Sitemap file
      --log=false: Enable Logging
      --logFile="": Log File path (if set, logging enabled automatically)
  -s, --source="": filesystem path to read files relative from
      --stepAnalysis=false: display memory and timing of different steps of the program
  -t, --theme="": theme to use (located in /themes/THEMENAME/)
      --uglyUrls=false: if true, use /filename.html instead of /filename/
  -v, --verbose=false: verbose output
      --verboseLog=false: verbose logging
  -w, --watch=false: watch filesystem for changes and recreate as needed

Use "hugo help [command]" for more information about that command.

Common Usage Example

The most common use is probably to run hugo with your current directory being the input directory.

$ hugo
> X pages created
  in 8 ms

If you are working on things and want to see the changes immediately, tell Hugo to watch for changes.

Hugo will watch the filesystem for changes, rebuild your site as soon as a file is saved.

$ hugo -s ~/mysite --watch
   28 pages created
   in 18 ms
   Watching for changes in /Users/spf13/Code/hugo/docs/content
   Press ctrl+c to stop

Hugo can even run a server and create your site at the same time! Hugo implements live reload technology to automatically reload any open pages in all browsers (including mobile).

$ hugo server -ws ~/mysite
   Watching for changes in /Users/spf13/Code/hugo/docs/content
   Web Server is available at http://localhost:1313
   Press ctrl+c to stop
   28 pages created
   0 tags created
   in 18 ms