hugo/docs/content/overview/quickstart.md

---
date: 2013-07-01
linktitle: Quickstart
menu:
  main:
    parent: getting started
next: /overview/installing
prev: /overview/introduction
title: Hugo Quickstart Guide
weight: 10
---

> _Note: This quickstart depends on features introduced in Hugo v0.11.  If you have an earlier version of Hugo, you will need to [upgrade](/overview/installing/) before proceeding._

{{% youtube w7Ft2ymGmfc %}}

## Step 1. Install Hugo

Go to [Hugo Releases](https://github.com/spf13/hugo/releases) and download the
appropriate version for your OS and architecture.

Save the main executable as `hugo` (or `hugo.exe` on Windows) somewhere in your `PATH` as we will be using it in the next step.

More complete instructions are available at [Installing Hugo](/overview/installing/).

## Step 2. Have Hugo Create a site for you

Hugo has the ability to create a skeleton site:

    $ hugo new site /path/to/site

For the rest of the operations, we will be executing all commands from within the site directory.

    $ cd /path/to/site

The new site will have the following structure

      ▸ archetypes/
      ▸ content/
      ▸ layouts/
      ▸ static/
        config.toml

Currently the site doesn’t have any content, nor is it configured.

## Step 3. Create Some Content

Hugo also has the ability to create a skeleton content page:

    $ hugo new about.md

A new file is now created in `content/` with the following contents:

```
+++
date = "2015-01-08T08:36:54-07:00"
draft = true
title = "about"

+++

```

Notice the date is automatically set to the moment you created the content.

Place some content in Markdown format below the `+++` in this file.
For example:

```markdown
## A headline

Some Content
```

For fun, let’s create another piece of content and place some Markdown in it as well.

    $ hugo new post/first.md

The new file is located at `content/post/first.md`

We still lack any templates to tell us how to display the content.

## Step 4. Install some themes

Hugo has rich theme support and a growing set of themes to choose from.
To install all of the available Hugo themes, simply clone the entire **hugoThemes** repository from within your working directory:

```bash
$ git clone --recursive https://github.com/spf13/hugoThemes themes
```

## Step 5. Run Hugo

Hugo contains its own high-performance web server. Simply run `hugo
server` and Hugo will find an available port and run a server with
your content:

    $ hugo server --theme=hyde --buildDrafts
    2 pages created
    0 tags created
    0 categories created
    in 5 ms
    Serving pages from exampleHugoSite/public
    Web Server is available at http://localhost:1313
    Press Ctrl+C to stop

We specified two options here:

 * `--theme` to pick which theme;
 * `--buildDrafts` because we want to display our content, both set to draft status.

To learn about what other options hugo has, run:

    $ hugo help

To learn about the server options:

    $ hugo help server

## Step 6. Edit Content

Not only can Hugo run a server, but it can also watch your files for
changes and automatically rebuild your site. Hugo will then
communicate with your browser and automatically reload any open page.
This even works in mobile browsers.

Stop the Hugo process by hitting <kbd>Ctrl</kbd>+<kbd>C</kbd>. Then run the following:

    $ hugo server --theme=hyde --buildDrafts --watch
    2 pages created
    0 tags created
    0 categories created
    in 5 ms
    Watching for changes in exampleHugoSite/content
    Serving pages from exampleHugoSite/public
    Web Server is available at http://localhost:1313
    Press Ctrl+C to stop

Open your [favorite editor](http://vim.spf13.com/), edit and save your content, and watch as Hugo rebuilds and reloads automatically.

It’s especially productive to leave a browser open on a second monitor
and just glance at it whenever you save. You don’t even need to tab to
your browser. Hugo is so fast that the new site will be there before
you can look at the browser in most cases.

Change and save this file. Notice what happened in your terminal:

    Change detected, rebuilding site

    2 pages created
    0 tags created
    0 categories created
    in 5 ms

## Step 7. 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/)
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
+								---
-												Converting front matter to YAML

											
										
										
											2014-05-29 22:42:05 +00:00
+								date: 2013-07-01
 								linktitle: Quickstart
-												Implementing new menu system in the docs site

											
										
										
											2014-04-23 07:00:11 +00:00
+								menu:
 								  main:
-												Converting front matter to YAML

											
										
										
											2014-05-29 22:42:05 +00:00
+								    parent: getting started
 								next: /overview/installing
 								prev: /overview/introduction
 								title: Hugo Quickstart Guide
 								weight: 10
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
+								---
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								> _Note: This quickstart depends on features introduced in Hugo v0.11.  If you have an earlier version of Hugo, you will need to [upgrade](/overview/installing/) before proceeding._
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
-												Added three videos to documentation.

Created shortcode for YouTube videos and made the videos responsive in the
stylesheet.

											
										
										
											2015-01-27 22:14:19 +00:00
+								{{% youtube w7Ft2ymGmfc %}}
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
+								## Step 1. Install Hugo
-												Minor proofreading corrections to Hugo docs

											
										
										
											2014-08-31 11:08:36 +00:00
+								Go to [Hugo Releases](https://github.com/spf13/hugo/releases) and download the
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								appropriate version for your OS and architecture.
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								Save the main executable as `hugo` (or `hugo.exe` on Windows) somewhere in your `PATH` as we will be using it in the next step.
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								More complete instructions are available at [Installing Hugo](/overview/installing/).
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
+								## Step 2. Have Hugo Create a site for you
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								Hugo has the ability to create a skeleton site:
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								    $ hugo new site /path/to/site
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								For the rest of the operations, we will be executing all commands from within the site directory.
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								    $ cd /path/to/site
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
+								The new site will have the following structure
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
+								      ▸ archetypes/
 								      ▸ content/
 								      ▸ layouts/
 								      ▸ static/
 								        config.toml
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
+								Currently the site doesn’t have any content, nor is it configured.
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
+								## Step 3. Create Some Content
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								Hugo also has the ability to create a skeleton content page:
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								    $ hugo new about.md
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								A new file is now created in `content/` with the following contents:
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								```
 								+++
 								date = "2015-01-08T08:36:54-07:00"
 								draft = true
 								title = "about"
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								+++
 								```
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								Notice the date is automatically set to the moment you created the content.
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								Place some content in Markdown format below the `+++` in this file.
 								For example:
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								```markdown
 								## A headline
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								Some Content
 								```
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
-												Minor proofreading corrections to Hugo docs

											
										
										
											2014-08-31 11:08:36 +00:00
+								For fun, let’s create another piece of content and place some Markdown in it as well.
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								    $ hugo new post/first.md
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
 								The new file is located at `content/post/first.md`
 								We still lack any templates to tell us how to display the content.
 								## Step 4. Install some themes
-												[Docs] Say which directory to clone the hugoThemes

On http://gohugo.io/overview/quickstart/, explicitly state
that hugoThemes is to be cloned from within the working directory,
like it is stated on http://gohugo.io/themes/installing/.

Fixes #886

											
										
										
											2015-02-09 02:42:59 +00:00
+								Hugo has rich theme support and a growing set of themes to choose from.
 								To install all of the available Hugo themes, simply clone the entire **hugoThemes** repository from within your working directory:
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
-												Docs: Minor copyediting/proofreading

- Correct some typos
- Add backticks and commas where necessary
- Use fenced code blocks specifying "bash" as the language
  to avoid weird highlighting
- Place commas outside of quotation marks surroundingn codes
  to avoid possible confusion
- Suggest users to use the discussion forum rather than the
  mailing list

											
										
										
											2014-12-04 16:26:12 +00:00
+								```bash
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								$ git clone --recursive https://github.com/spf13/hugoThemes themes
-												Docs: Minor copyediting/proofreading

- Correct some typos
- Add backticks and commas where necessary
- Use fenced code blocks specifying "bash" as the language
  to avoid weird highlighting
- Place commas outside of quotation marks surroundingn codes
  to avoid possible confusion
- Suggest users to use the discussion forum rather than the
  mailing list

											
										
										
											2014-12-04 16:26:12 +00:00
+								```
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
 								## Step 5. Run Hugo
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								Hugo contains its own high-performance web server. Simply run `hugo
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
+								server` and Hugo will find an available port and run a server with
-												Minor proofreading corrections to Hugo docs

											
										
										
											2014-08-31 11:08:36 +00:00
+								your content:
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								    $ hugo server --theme=hyde --buildDrafts
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
+pages created
 tags created
 categories created
 								    in 5 ms
 								    Serving pages from exampleHugoSite/public
 								    Web Server is available at http://localhost:1313
-												Change "ctrl+c" to "Ctrl+C"

											
										
										
											2015-01-29 21:19:12 +00:00
+								    Press Ctrl+C to stop
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
-												Minor proofreading corrections to Hugo docs

											
										
										
											2014-08-31 11:08:36 +00:00
+								We specified two options here:
-												Add empty line to correctly render a list

											
										
										
											2014-06-03 14:18:55 +00:00
-												Minor proofreading corrections to Hugo docs

											
										
										
											2014-08-31 11:08:36 +00:00
+								 * `--theme` to pick which theme;
 								 * `--buildDrafts` because we want to display our content, both set to draft status.
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
-												Minor proofreading corrections to Hugo docs

											
										
										
											2014-08-31 11:08:36 +00:00
+								To learn about what other options hugo has, run:
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								    $ hugo help
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
-												Minor proofreading corrections to Hugo docs

											
										
										
											2014-08-31 11:08:36 +00:00
+								To learn about the server options:
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								    $ hugo help server
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
 								## Step 6. Edit Content
 								Not only can Hugo run a server, but it can also watch your files for
 								changes and automatically rebuild your site. Hugo will then
 								communicate with your browser and automatically reload any open page.
 								This even works in mobile browsers.
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								Stop the Hugo process by hitting <kbd>Ctrl</kbd>+<kbd>C</kbd>. Then run the following:
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								    $ hugo server --theme=hyde --buildDrafts --watch
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
+pages created
 tags created
 categories created
 								    in 5 ms
 								    Watching for changes in exampleHugoSite/content
 								    Serving pages from exampleHugoSite/public
 								    Web Server is available at http://localhost:1313
-												Change "ctrl+c" to "Ctrl+C"

											
										
										
											2015-01-29 21:19:12 +00:00
+								    Press Ctrl+C to stop
-												quickstart.md: Put long options inside backticks

Also minor adjustment to blank lines.

											
										
										
											2014-08-29 23:38:32 +00:00
-												[Docs] Copyediting

 * Add meta author, description and generator tags
 * Add Hugo version beside the logo and in the footer
 * Suggest the user to run `go get -u -v` to update dependencies
 * Requires Go 1.3+ rather than Go 1.1+
 * Improve rendering/formatting in some places
 * Add trailing slash to URLs where appropriate
 * GitHub redirects all http requests to https, update accordingly

											
										
										
											2015-01-28 02:17:09 +00:00
+								Open your [favorite editor](http://vim.spf13.com/), edit and save your content, and watch as Hugo rebuilds and reloads automatically.
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
 								It’s especially productive to leave a browser open on a second monitor
 								and just glance at it whenever you save. You don’t even need to tab to
-												Minor proofreading corrections to Hugo docs

											
										
										
											2014-08-31 11:08:36 +00:00
+								your browser. Hugo is so fast that the new site will be there before
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
+								you can look at the browser in most cases.
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								Change and save this file. Notice what happened in your terminal:
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
+								    Change detected, rebuilding site
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
+pages created
 tags created
 categories created
 								    in 5 ms
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
+								## Step 7. Have fun
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
 								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/)
-												Minor proofreading corrections to Hugo docs

											
										
										
											2014-08-31 11:08:36 +00:00
+								 * Create content with [TOML front matter](/content/front-matter/)
-												Adding a quick start guide to hugo docs

											
										
										
											2013-10-18 02:53:04 +00:00
+								 * 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/)