mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
2e711a28c7
af4b7ac5b Remove mention of Amber and Ace c841e9207 Exif docs corrections (#978) 0f82420b8 Change cache assets default example to 1 year 676dc6e12 Release 0.61.0 a1d9fb18a Merge commit '79c5d7053486f540b6219e693d5590f2c4c3937a' 1b9e675cd releaser: Add release notes to /docs for release of 0.61.0 5b95cbc8a Fixed suffixIsRemoved error in code samples (#975) 59b2c245b Fix Usage section in toc.md to consider Goldmark TOC settings fd3828673 Add link on how to configure TOC w/ Goldmark ea339f2d6 Added external learning resources including Hugo In Action book. fab502d5d Adjust release notes 269a025ef Release 0.60.1 6bff50bea Merge branch 'temp601' e15251c43 releaser: Add release notes to /docs for release of 0.60.1 690b864b9 Update use-modules.md 345ca8c36 Update syntax-highlighting.md be64af9f5 Update syntax-highlighting.md df9dead83 Update syntax-highlighting.md 1c6e6d238 Fix relnotes 0ea6b2012 Update homepagetweets.toml 2c465625d Update index.md 0025bba09 Update index.md 7417f1c05 Update index.md 9eeb8ce57 Release 0.60.0 25a711023 Merge branch 'temp60' 0c4faab0e releaser: Add release notes to /docs for release of 0.60.0 779e5108e Update installing.md 2ef1c386a Minor text improvements in README.md 41ec5a19a Reword sentence for clarity search.md ded74f098 Add Goldmark as the new default markdown handler cb55cdbb0 Update introduction.md fcaad653a Update homepage.md 7427a1fc5 Update configuration.md 8cc2c72ca tpl/collections: Allow dict to create nested structures 4538c092c Merge commit 'efc0b1bb6c6564f54d596467dbc6a18cb206954e' 90f908e7b Support Go time format strings in permalinks git-subtree-dir: docs git-subtree-split: af4b7ac5b403e392a92228e66058331905fff7dc
188 lines
5.2 KiB
Markdown
188 lines
5.2 KiB
Markdown
---
|
|
title: Quick Start
|
|
linktitle: Quick Start
|
|
description: Create a Hugo site using the beautiful Ananke theme.
|
|
date: 2013-07-01
|
|
publishdate: 2013-07-01
|
|
categories: [getting started]
|
|
keywords: [quick start,usage]
|
|
authors: [Shekhar Gulati, Ryan Watters]
|
|
menu:
|
|
docs:
|
|
parent: "getting-started"
|
|
weight: 10
|
|
weight: 10
|
|
sections_weight: 10
|
|
draft: false
|
|
aliases: [/quickstart/,/overview/quickstart/]
|
|
toc: true
|
|
---
|
|
|
|
{{% note %}}
|
|
This quick start uses `macOS` in the examples. For instructions about how to install Hugo on other operating systems, see [install](/getting-started/installing).
|
|
|
|
It is recommended to have [Git installed](https://git-scm.com/downloads) to run this tutorial.
|
|
|
|
For other approaches learning Hugo like book or a video tutorial refer to the [external learning resources](/getting-started/external-learning-resources/) page.
|
|
{{% /note %}}
|
|
|
|
|
|
|
|
## Step 1: Install Hugo
|
|
|
|
{{% note %}}
|
|
`Homebrew`, a package manager for `macOS`, can be installed from [brew.sh](https://brew.sh/). See [install](/getting-started/installing) if you are running Windows etc.
|
|
{{% /note %}}
|
|
|
|
```bash
|
|
brew install hugo
|
|
```
|
|
|
|
To verify your new install:
|
|
|
|
```bash
|
|
hugo version
|
|
```
|
|
|
|
|
|
{{< asciicast ItACREbFgvJ0HjnSNeTknxWy9 >}}
|
|
|
|
|
|
## Step 2: Create a New Site
|
|
|
|
```bash
|
|
hugo new site quickstart
|
|
```
|
|
|
|
The above will create a new Hugo site in a folder named `quickstart`.
|
|
|
|
{{< asciicast 3mf1JGaN0AX0Z7j5kLGl3hSh8 >}}
|
|
|
|
|
|
## Step 3: Add a Theme
|
|
|
|
See [themes.gohugo.io](https://themes.gohugo.io/) for a list of themes to consider. This quickstart uses the beautiful [Ananke theme](https://themes.gohugo.io/gohugo-theme-ananke/).
|
|
|
|
```bash
|
|
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 7naKerRYUGVPj8kiDmdh5k5h9 >}}
|
|
|
|
|
|
## Step 4: Add Some Content
|
|
|
|
You can manually create content files (for example as `content/<CATEGORY>/<FILE>.<FORMAT>`) and provide metadata in them, however you can use the `new` command to do few things for you (like add title and date):
|
|
|
|
```
|
|
hugo new posts/my-first-post.md
|
|
```
|
|
|
|
{{< asciicast eUojYCfRTZvkEiqc52fUsJRBR >}}
|
|
|
|
Edit the newly created content file if you want, it will start with something like this:
|
|
|
|
```markdown
|
|
---
|
|
title: "My First Post"
|
|
date: 2019-03-26T08:47:11+01:00
|
|
draft: true
|
|
---
|
|
|
|
```
|
|
|
|
|
|
## Step 5: Start the Hugo server
|
|
|
|
Now, start the Hugo server with [drafts](/getting-started/usage/#draft-future-and-expired-content) enabled:
|
|
|
|
{{< asciicast BvJBsF6egk9c163bMsObhuNXj >}}
|
|
|
|
|
|
|
|
```
|
|
▶ hugo server -D
|
|
|
|
| EN
|
|
+------------------+----+
|
|
Pages | 10
|
|
Paginator pages | 0
|
|
Non-page files | 0
|
|
Static files | 3
|
|
Processed images | 0
|
|
Aliases | 1
|
|
Sitemaps | 1
|
|
Cleaned | 0
|
|
|
|
Total in 11 ms
|
|
Watching for changes in /Users/bep/quickstart/{content,data,layouts,static,themes}
|
|
Watching for config changes in /Users/bep/quickstart/config.toml
|
|
Environment: "development"
|
|
Serving pages from memory
|
|
Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender
|
|
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/](http://localhost:1313/).**
|
|
|
|
Feel free to edit or add new content and simply refresh in browser to see changes quickly (You might need to force refresh in webbrowser, something like Ctrl-R usually works).
|
|
|
|
|
|
## 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](https://kb.iu.edu/d/ahic).
|
|
{{% /note %}}
|
|
|
|
|
|
For theme specific configuration options, see the [theme site](https://github.com/budparr/gohugo-theme-ananke).
|
|
|
|
**For further theme customization, see [Customize a Theme](/themes/customizing/).**
|
|
|
|
|
|
### Step 7: Build static pages
|
|
|
|
It is simple. Just call:
|
|
|
|
```
|
|
hugo -D
|
|
```
|
|
|
|
Output will be in `./public/` directory by default (`-d`/`--destination` flag to change it, or set `publishdir` in the config file).
|
|
|
|
{{% note %}}
|
|
Drafts do not get deployed; once you finish a post, update the header of the post to say `draft: false`. More info [here](/getting-started/usage/#draft-future-and-expired-content).
|
|
{{% /note %}}
|