mirror of
https://github.com/gohugoio/hugo.git
synced 2025-05-08 00:13:10 +00:00
39a7fac34 Add .hugo_build.lock to .gitignore 920c716a4 fix a typo: to -> two (#1545) 6f0ba9593 Remove godocref from front matter (#1543) 8ec3d5948 remove link to wercker (#1544) b56008719 Delete deployment-with-wercker.md (#1542) e33d29b02 Fix broken links (#1538) 29e9d4c21 Sort commenting systems (#1541) 0b7ea60a7 Delete the news page "HTTP/2 Server Push in Hugo" 6e1515857 Fix quick-start.md (#1525) 62168ab35 Update comments.md (#1535) d92191512 Small typo (#1539) 129c8834a Correct the PostCSS noMap default value (#1534) 6a5b29fcc Add example to index function (#1536) e3dd8c507 Update output-formats.md 0c9321ca0 Remove reference to using LiveReload in production environment 4072d6776 Mod testing 09fabf7d6 Fix typo (#1524) 2fce813c8 Fix grammatical error in quick-start.md (#1523) 45230ab4a Hugo Mod testing 2dd4cd9e7 Update index.md 2c3ed62fd netlify: Bump to 0.88.1 648e2a007 Merge branch 'tempv0.88.1' f216eade1 releaser: Add release notes to /docs for release of 0.88.1 8a7b64d4b Fix typographical errors in 0.88.0 release notes a4bf86300 Release 0.88 738bb8f38 releaser: Add release notes to /docs for release of 0.88.0 8fcf2c55d highlight: Remove some pygments references f2b173de2 HTTPS link c88881c8e Adding link to nginx documentation 6b0a74fe0 Fix typos in docs (#1516) 498b8f0f1 Fix typos in time.Format (#1515) 28723fad6 Fix taxonomy and term examples (#1514) 3ffd00e12 Update front-matter.md 7cc1da82e Fix grammar in 0.86.1 release notes (#1510) 0009c51c3 Update docs helper 7e2f430f4 Update index.md 7857eae7e releaser: Add release notes to /docs for release of 0.87.0 1f08b684b releaser: Add release notes to /docs for release of 0.87.0 36a9e701c docs: Adjust config docs 0f588438e docs: Regen CLI docs 1b4682cd8 docs: Regen docs helper bc8bbaae9 Merge commit 'bd77f6e1c99e04a476f0b1bb4e44569134e02399' into release-0.87.0 6f2480643 docs: Adjust time zone docs git-subtree-dir: docs git-subtree-split: 39a7fac343c289906db644c96079fdcc0298582f
179 lines
5.4 KiB
Markdown
179 lines
5.4 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 to learning Hugo (like books or video tutorials), refer to the [external learning resources](/getting-started/external-learning-resources/) page.
|
|
{{% /note %}}
|
|
|
|
## Step 1: Install Hugo
|
|
|
|
{{% note %}}
|
|
`Homebrew` and `MacPorts`, package managers for `macOS`, can be installed from [brew.sh](https://brew.sh/) or [macports.org](https://www.macports.org/) respectively. See [install](/getting-started/installing) if you are running Windows etc.
|
|
{{% /note %}}
|
|
|
|
```bash
|
|
brew install hugo
|
|
# or
|
|
port 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/).
|
|
|
|
First, download the theme from GitHub and add it to your site's `themes` directory:
|
|
|
|
```bash
|
|
cd quickstart
|
|
git init
|
|
git submodule add https://github.com/theNewDynamic/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/theNewDynamic/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.
|
|
|
|
Then, add the theme to the site configuration:
|
|
|
|
```bash
|
|
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 a 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
|
|
---
|
|
|
|
```
|
|
|
|
{{% 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 %}}
|
|
|
|
## 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 your web browser, 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/theNewDynamic/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).
|
|
|