mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
b0181e278b
- 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.
164 lines
4.4 KiB
Markdown
164 lines
4.4 KiB
Markdown
---
|
||
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._
|
||
|
||
## 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:
|
||
|
||
```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/)
|