HUGO 中文文档

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
gohugoio Star
  • 关于
    • 本节内容
    • 简介
    • 特性
    • 隐私
    • 安全
    • 许可证
  • 安装
    • 本节内容
    • macOS
    • Linux
    • Windows
    • BSD
  • 快速上手
    • 本节内容
    • 快速入门
    • 基本用法
    • 目录结构
    • 配置
    • 配置标记
    • 术语表
    • 配置构建
    • 外部学习资源
  • 快速参考
    • 本节内容
    • 表情符号
    • 函数
    • 方法
    • 页面集合
  • 内容管理
    • 本节内容
    • 组织
    • 页面包
    • 内容格式
    • Front matter (前置 matter)
    • 构建选项
    • 页面资源
    • 图片处理
    • 短代码
    • 相关内容
    • 章节
    • 内容类型
    • 原型
    • 分类法
    • 摘要
    • 链接和交叉引用
    • URL 管理
    • 菜单
    • 评论
    • 多语言
    • Markdown 属性
    • 语法高亮
    • 图表
    • 数学公式
    • 数据源
    • 内容适配器
  • 模板
    • 本节内容
    • 简介
    • 模板类型
    • 查找顺序
    • 基模板
    • 首页模板
    • 单个模板
    • 章节模板
    • 分类模板
    • 术语模板
    • 局部模板
    • 内容视图模板
    • 短代码模板
    • 站点地图模板
    • RSS 模板
    • 404 模板
    • robots.txt 模板
    • 菜单
    • 分页
    • 内嵌模板
    • 自定义输出格式
  • 函数
    • 本节内容
    • css
    • fmt
    • go 模板
    • hugo
    • js
    • lang
    • openapi3
    • os
    • urls
    • 全局
    • 加密
    • 反射
    • 变形
    • 变换
    • 哈希
    • 图像
    • 图表函数
    • 字符串
    • 安全函数
    • 局部模板函数
    • 数学
    • 数据
    • 时间
    • 模板
    • 比较
    • 类型转换
    • 编码
    • 调试
    • 资源
    • 路径
    • 集合
  • 方法
    • 本节内容
    • Duration
    • Menu
    • Page
    • Pager
    • Resource
    • Shortcode
    • Site
    • Taxonomy
    • Time
    • 菜单项
    • 页面
  • 渲染钩子
    • 本节内容
    • 简介
    • 块引用
    • 代码块
    • 标题
    • Images
    • 链接
    • Passthrough
    • 表格
  • Hugo 模块
    • 本节内容
    • 配置 Hugo 模块
    • 使用 Hugo 模块
    • 主题组件
  • Hugo 管道
    • 本节内容
    • 简介
    • 将 Sass 编译为 CSS
    • PostCSS
    • PostProcess
    • JavaScript 构建
    • 资源压缩
    • 连接资产
    • 指纹和 SRI 哈希
    • 从字符串创建资源
    • 从模板创建资源
  • 命令行界面
  • 故障排除
    • 本节内容
    • Audit
    • 日志记录
    • 检查
    • 弃用
    • 性能
    • FAQs
  • 开发者工具
    • 本节内容
    • 编辑器插件
    • 前端
    • Search
    • 迁移
    • 其他项目
  • 托管和部署
    • 本节内容
    • Hugo 部署
    • 使用 Rclone 部署
    • 使用 Rsync 部署
    • 在 21YunBox 上托管
    • 在 AWS Amplify 上托管
    • 在 Cloudflare Pages 上托管
    • 在 Firebase 上托管
    • 在 GitLab Pages 上托管
    • 在 Netlify 上托管
    • 在 Render 上托管
    • 托管在 Azure 静态 Web 应用上
    • 托管在 GitHub Pages 上
    • 托管在 KeyCDN 上
  • 贡献
    • 本节内容
    • 开发
    • 文档
    • 主题
  • 维护
GETTING STARTED

快速入门

几分钟内学会创建 Hugo 站点。

本教程将指导您:

  1. 创建站点
  2. 添加内容
  3. 配置站点
  4. 发布站点

预备条件

在开始本教程之前,您必须:

  1. 安装 Hugo (扩展版或扩展/部署版,v0.128.0 或更高版本)
  2. 安装 Git

您还必须能够熟练使用命令行。

创建站点

命令

如果您是 Windows 用户:

  • 不要使用命令提示符
  • 不要使用 Windows PowerShell
  • 从 PowerShell 或 Linux 终端(例如 WSL 或 Git Bash)运行这些命令

PowerShell 和 Windows PowerShell 是不同的应用程序 。

验证您已安装 Hugo v0.128.0 或更高版本。

hugo version

运行以下命令使用 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

在终端显示的 URL 中查看您的站点。按 Ctrl + C 停止 Hugo 的开发服务器。

命令解释

在 quickstart 目录中为您的项目创建 目录结构 。

hugo new site quickstart

将当前目录更改为项目的根目录。

cd quickstart

在当前目录中初始化一个空的 Git 仓库。

git init

将 Ananke 主题克隆到 themes 目录,将其作为 Git 子模块 添加到您的项目中。

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

向站点配置文件追加一行,指示当前主题。

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

启动 Hugo 的开发服务器以查看站点。

hugo server

按 Ctrl + C 停止 Hugo 的开发服务器。

添加内容

向您的站点添加一个新页面。

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

Hugo 在 content/posts 目录中创建了该文件。使用您的编辑器打开该文件。

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

请注意 前置 matter 中的 draft 值为 true 。默认情况下,当您构建站点时,Hugo 不会发布草稿内容。了解更多关于 草稿、未来和过期内容 的信息。

向文章正文添加一些 Markdown 内容,但不要更改 draft 值。

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

这是 **粗体** 文本,这是 *强调* 文本。

访问 [Hugo](https://gohugo.io) 网站!

保存文件,然后启动 Hugo 的开发服务器以查看站点。您可以运行以下任一命令以包含草稿内容。

hugo server --buildDrafts
hugo server -D

在终端显示的 URL 中查看您的站点。在继续添加和更改内容时,请保持开发服务器运行。

对新内容满意后,将前置 matter 的 draft 参数设置为 false 。

Hugo 的渲染引擎符合 Markdown 的 CommonMark 规范 。CommonMark 组织提供了一个由参考实现驱动的有用的 实时测试工具 。

配置站点

使用您的编辑器,打开项目根目录中的 站点配置 文件 (hugo.toml)。

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

进行以下更改:

  1. 设置生产站点的 baseURL 。此值必须以协议开头,以斜杠结尾,如上所示。

  2. 将 languageCode 设置为您的语言和地区。

  3. 设置生产站点的 title 。

启动 Hugo 的开发服务器以查看您的更改,记住要包含草稿内容。

hugo server -D

大多数主题作者都提供了配置指南和选项。请务必访问您的主题的代码库或文档站点以了解更多详情。

The New Dynamic ,Ananke 主题的作者,提供了关于配置和使用的 文档 。他们还提供了一个 演示站点 。

发布站点

在此步骤中,您将 发布 您的站点,但不会 部署 它。

当您 发布 您的站点时,Hugo 会在项目根目录的 public 目录中创建整个静态站点。这包括 HTML 文件和资源,例如图像、CSS 文件和 JavaScript 文件。

发布站点时,通常 不 希望包含 草稿、未来或过期内容 。命令很简单。

hugo

要了解如何 部署 您的站点,请参阅 托管和部署 部分。

寻求帮助

Hugo 的 论坛 是一个活跃的用户和开发者社区,他们会解答问题、分享知识并提供示例。快速搜索超过 20,000 个主题通常就能解答您的问题。请务必阅读关于 [寻求帮助] 的内容,然后再提出您的第一个问题。

其他资源

有关帮助您学习 Hugo 的其他资源,包括书籍和视频教程,请参阅 外部学习资源 页面。

See also

  • 托管在 GitHub Pages 上
  • BSD
  • Git信息
  • Linux
  • Windows

On this page

  • 预备条件
  • 创建站点
  • 添加内容
  • 配置站点
  • 发布站点
  • 寻求帮助
  • 其他资源
Last updated: January 10, 2025: 添加 gtm 谷歌代码管理 (6220bf5)
Improve this page
By the Hugo Authors
Hugo Logo
  • File an Issue
  • Get Help
  • @GoHugoIO
  • @spf13
  • @bepsays
 

Hugo Sponsors

Your Company?
 

The Hugo logos are copyright © Steve Francia 2013–2025.

The Hugo Gopher is based on an original work by Renée French.

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
  • 关于
  • 安装
  • 快速上手
  • 快速参考
  • 内容管理
  • 模板
  • 函数
  • 方法
  • 渲染钩子
  • Hugo 模块
  • Hugo 管道
  • 命令行界面
  • 故障排除
  • 开发者工具
  • 托管和部署
  • 贡献
  • 维护