2013-10-17 22:53:04 -04:00
|
|
|
---
|
|
|
|
|
title: "Hugo Quickstart Guide"
|
|
|
|
|
date: "2013-07-01"
|
2013-10-25 18:42:46 -04:00
|
|
|
linktitle: "Quickstart"
|
2014-04-23 03:00:11 -04:00
|
|
|
weight: 10
|
|
|
|
|
menu:
|
|
|
|
|
main:
|
|
|
|
|
parent: 'getting started'
|
2013-10-17 22:53:04 -04:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Step 1. Install Hugo
|
|
|
|
|
|
|
|
|
|
Goto [hugo releases](https://github.com/spf13/hugo/releases) and download the
|
|
|
|
|
appropriate version for your os and architecture.
|
|
|
|
|
|
|
|
|
|
Save it somewhere specific as we will be using it in the next step.
|
|
|
|
|
|
|
|
|
|
More complete instructions are available at [installing hugo](/overview/installing/)
|
|
|
|
|
|
|
|
|
|
## Step 2. Build the Docs
|
|
|
|
|
|
2014-03-05 21:31:37 -05:00
|
|
|
Hugo has its own example site which happens to also be the documentation site
|
2013-10-17 22:53:04 -04:00
|
|
|
you are reading right now.
|
|
|
|
|
|
|
|
|
|
Follow the following steps:
|
|
|
|
|
|
|
|
|
|
1. Clone the [hugo repository](http://github.com/spf13/hugo)
|
|
|
|
|
2. Go into the repo
|
|
|
|
|
3. Run hugo in server mode and build the docs
|
|
|
|
|
4. Open your browser to http://localhost:1313
|
|
|
|
|
|
|
|
|
|
Corresponding pseudo commands:
|
|
|
|
|
|
|
|
|
|
git clone https://github.com/spf13/hugo
|
|
|
|
|
cd hugo
|
2014-03-05 21:31:37 -05:00
|
|
|
/path/to/where/you/installed/hugo server --source=./docs
|
2013-10-17 22:53:04 -04:00
|
|
|
> 29 pages created
|
|
|
|
|
> 0 tags index created
|
|
|
|
|
> in 27 ms
|
|
|
|
|
> Web Server is available at http://localhost:1313
|
|
|
|
|
> Press ctrl+c to stop
|
|
|
|
|
|
|
|
|
|
Once you've gotten here, follow along the rest of this page on your local build.
|
|
|
|
|
|
|
|
|
|
## Step 3. Change the docs site
|
|
|
|
|
|
|
|
|
|
Stop the Hugo process by hitting ctrl+c.
|
|
|
|
|
|
|
|
|
|
Now we are going to run hugo again, but this time with hugo in watch mode.
|
|
|
|
|
|
2013-11-23 10:36:33 -05:00
|
|
|
/path/to/hugo/from/step/1/hugo server --source=./docs --watch
|
2013-10-17 22:53:04 -04:00
|
|
|
> 29 pages created
|
|
|
|
|
> 0 tags index created
|
|
|
|
|
> in 27 ms
|
|
|
|
|
> Web Server is available at http://localhost:1313
|
|
|
|
|
> Watching for changes in /Users/spf13/Code/hugo/docs/content
|
|
|
|
|
> Press ctrl+c to stop
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Open your [favorite editor](http://vim.spf13.com) and change one of the source
|
|
|
|
|
content pages. How about changing this very file to *fix the typo*. How about changing this very file to *fix the typo*.
|
|
|
|
|
|
|
|
|
|
Content files are found in `docs/content/`. Unless otherwise specified, files
|
|
|
|
|
are located at the same relative location as the url, in our case
|
|
|
|
|
`docs/content/overview/quickstart.md`.
|
|
|
|
|
|
|
|
|
|
Change and save this file.. Notice what happened in your terminal.
|
|
|
|
|
|
|
|
|
|
> Change detected, rebuilding site
|
|
|
|
|
|
|
|
|
|
> 29 pages created
|
|
|
|
|
> 0 tags index created
|
|
|
|
|
> in 26 ms
|
|
|
|
|
|
|
|
|
|
Refresh the browser and observe that the typo is now fixed.
|
|
|
|
|
|
|
|
|
|
Notice how quick that was. Try to refresh the site before it's finished building.. I double dare you.
|
|
|
|
|
Having nearly instant feedback enables you to have your creativity flow without waiting for long builds.
|
|
|
|
|
|
|
|
|
|
## Step 4. Have fun
|
|
|
|
|
|
|
|
|
|
The best way to learn something is to play with it.
|
|
|
|
|
|
|
|
|
|
Things to try:
|
|
|
|
|
|
|
|
|
|
* Add a [new content file](/content/organization/)
|
|
|
|
|
* Create a [new section](/content/sections/)
|
|
|
|
|
* Modify [a template](/layout/templates/)
|
|
|
|
|
* Create content with [toml front matter](/content/front-matter/)
|
|
|
|
|
* Define your own field in [front matter](/content/front-matter/)
|
|
|
|
|
* Display that [field in the template](/layout/variables/)
|
|
|
|
|
* Create a [new content type](/content/types/)
|
