Quick start (快速启动)

Quick start (快速启动)

Learn to create a Hugo site in minutes. (学习如何在几分钟内创建一个 Hugo 网站。)

In this tutorial(教程) you will:

  1. Create a site 创建站点
  2. Add content 添加内容
  3. Configure the site 配置站点
  4. Publish the site 发布网站

Prerequisites 先决条件 #

Before you begin this tutorial you must:

在开始本教程之前,你必须

  1. [Install Hugo] (extended or extended/deploy edition, v0.128.0 or later) 安装Hugo 扩展/部署版本 v0.128.0或者更高版本
  2. [Install Git] 安装git

You must also be comfortable working from the command line.

你必须能熟练使用命令行进行工作

Create a site 创建站点 #

Commands 命令 #

Verify that you have installed Hugo v0.128.0 or later. 验证你是否安装Hugo v0.128.0或者更高版本

hugo version

Run these commands to create a Hugo site with the [Ananke] theme. The next section provides an explanation of each command. 运行这些命令以使用Ananke主题创建 Hugo 站点。下一节将对每个命令进行解释。

hugo new site quickstart
cd quickstart
git init
git submodule add https://github.com/theNewDynamic/gohugo-theme-ananke.git themes/ananke
echo "theme = 'ananke'" >> hugo.toml
hugo server

View your site at the URL displayed in your terminal. Press Ctrl + C to stop Hugo’s development server.

Explanation of commands 命令说明 #

Create the [directory structure] for your project in the quickstart directory.

hugo new site quickstart

Change the current directory to the root of your project. 将当前目录更改为项目的根目录

cd quickstart

Initialize an empty Git repository in the current directory.

在当前目录中初始化一个空的git存储库

git init

Clone the [Ananke] theme into the themes directory, adding it to your project as a [Git submodule].

git submodule add https://github.com/theNewDynamic/gohugo-theme-ananke.git themes/ananke

Append a line to the site configuration file, indicating the current theme.

echo "theme = 'ananke'" >> hugo.toml

Start Hugo’s development server to view the site.

hugo server

Press Ctrl + C to stop Hugo’s development server.

Add content #

Add a new page to your site.

hugo new content content/posts/my-first-post.md

Hugo created the file in the content/posts directory. Open the file with your editor.

+++
title = 'My First Post'
date = 2024-01-14T07:07:07+01:00
draft = true
+++

Notice the draft value in the [front matter] is true. By default, Hugo does not publish draft content when you build the site. Learn more about [draft, future, and expired content].

Add some [Markdown] to the body of the post, but do not change the draft value.

+++
title = 'My First Post'
date = 2024-01-14T07:07:07+01:00
draft = true
+++
## Introduction

This is **bold** text, and this is *emphasized* text.

Visit the [Hugo](https://gohugo.io) website!

Save the file, then start Hugo’s development server to view the site. You can run either of the following commands to include draft content.

hugo server --buildDrafts
hugo server -D

View your site at the URL displayed in your terminal. Keep the development server running as you continue to add and change content.

When satisfied with your new content, set the front matter draft parameter to false.

Configure the site #

With your editor, open the [site configuration] file (hugo.toml) in the root of your project.

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

Make the following changes:

  1. Set the baseURL for your production site. This value must begin with the protocol and end with a slash, as shown above.
  2. Set the languageCode to your language and region.
  3. Set the title for your production site.

Start Hugo’s development server to see your changes, remembering to include draft content.

hugo server -D

Publish the site #

In this step you will publish your site, but you will not deploy it.

When you publish your site, Hugo creates the entire static site in the public directory in the root of your project. This includes the HTML files, and assets such as images, CSS files, and JavaScript files.

When you publish your site, you typically do not want to include [draft, future, or expired content]. The command is simple.

hugo

To learn how to deploy your site, see the [hosting and deployment] section.

Ask for help #

Hugo’s [forum] is an active community of users and developers who answer questions, share knowledge, and provide examples. A quick search of over 20,000 topics will often answer your question. Please be sure to read about [requesting help] before asking your first question.

Other resources #

For other resources to help you learn Hugo, including books and video tutorials, see the external learning resources page.