Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
154 lines (105 sloc) 3.96 KB
title linktitle description date publishdate categories keywords authors menu weight sections_weight draft aliases toc
Quick Start
Quick Start
Create a Hugo site using the beautiful Ananke theme.
2013-07-01
2013-07-01
getting started
quick start
usage
Shekhar Gulati
Ryan Watters
docs
parent weight
getting-started
10
10
10
false
/quickstart/
/overview/quickstart/
true

{{% note %}} This quick start uses macOS in the examples. For instructions about how to install Hugo on other operating systems, see install.

It is recommended to have Git installed to run this tutorial. {{% /note %}}

Step 1: Install Hugo

{{% note %}} Homebrew, a package manager for macOS, can be installed from brew.sh. See install if you are running Windows etc. {{% /note %}}

brew install hugo

To verify your new install:

hugo version

{{< asciicast HDlKrUrbfT7yiWsbd6QoxzRTN >}}

Step 2: Create a New Site

hugo new site quickstart

The above will create a new Hugo site in a folder named quickstart.

{{< asciicast 1PH9A2fs14Dnyarx5v8OMYQer >}}

Step 3: Add a Theme

See themes.gohugo.io for a list of themes to consider. This quickstart uses the beautiful Ananke theme.

cd quickstart

# Download the theme
git init
git submodule add https://github.com/budparr/gohugo-theme-ananke.git themes/ananke
# Note for non-git users:
#   - If you do not have git installed, you can download the archive of the latest
#     version of this theme from:
#       https://github.com/budparr/gohugo-theme-ananke/archive/master.zip
#   - Extract that .zip file to get a "gohugo-theme-ananke-master" directory.
#   - Rename that directory to "ananke", and move it into the "themes/" directory.
# End of note for non-git users.

# Edit your config.toml configuration file
# and add the Ananke theme.
echo 'theme = "ananke"' >> config.toml

{{< asciicast WJM2LEZQs8VRhNeuZ5NiGPp9I >}}

Step 4: Add Some Content

hugo new posts/my-first-post.md

Edit the newly created content file if you want.

Step 5: Start the Hugo server

Now, start the Hugo server with drafts enabled:

▶ hugo server -D

Started building sites ...
Built site for language en:
1 of 1 draft rendered
0 future content
0 expired content
1 regular pages created
8 other pages created
0 non-page files copied
1 paginator pages created
0 categories created
0 tags created
total in 18 ms
Watching for changes in /Users/bep/sites/quickstart/{data,content,layouts,static,themes}
Serving pages from memory
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop

Navigate to your new site at http://localhost:1313/.

Step 6: Customize the Theme

Your new site already looks great, but you will want to tweak it a little before you release it to the public.

Site Configuration

Open up config.toml in a text editor:

baseURL = "https://example.org/"
languageCode = "en-us"
title = "My New Hugo Site"
theme = "ananke"

Replace the title above with something more personal. Also, if you already have a domain ready, set the baseURL. Note that this value is not needed when running the local development server.

{{% note %}} Tip: Make the changes to the site configuration or any other file in your site while the Hugo server is running, and you will see the changes in the browser right away, though you may need to clear your cache. {{% /note %}}

For theme specific configuration options, see the theme site.

For further theme customization, see Customize a Theme.

Recapitulation

{{< asciicast pWp4uvyAkdWgQllD9RCfeBL5k >}}