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 的命令行界面 (CLI) 功能齐全,但易于使用,即使是那些在命令行工作经验有限的人也能轻松上手。

测试你的安装

在 安装 Hugo 后,通过运行以下命令测试你的安装:

hugo version

你应该会看到类似以下内容:

hugo v0.123.0-3c8a4713908e48e6523f058ca126710397aa4ed5+extended linux/amd64 BuildDate=2024-02-19T16:32:38Z VendorInfo=gohugoio

显示可用命令

要查看可用命令和标志的列表:

hugo help

要获取子命令的帮助,请使用 --help 标志。例如:

hugo server --help

构建你的网站

要构建你的网站, cd 到你的项目目录并运行:

hugo

hugo 命令构建你的网站,并将文件发布到 public 目录。要将你的网站发布到其他目录,请使用 --destination 标志或在你的站点配置中设置 publishDir 。

Hugo 在构建你的网站之前不会清除 public 目录。现有文件会被覆盖,但不会被删除。此行为是故意的,以防止意外删除你可能在构建后添加到 public 目录的文件。

根据你的需要,你可能希望在每次构建之前手动清除 public 目录的内容。

草稿、未来和过期内容

Hugo 允许你设置内容 前置 matter 中的 draft 、 date 、 publishDate 和 expiryDate 。默认情况下,Hugo 不会发布内容,如果:

  • draft 值为 true
  • date 在未来
  • publishDate 在未来
  • expiryDate 在过去
New in v0.123.0

Hugo 发布草稿、未来和过期 节点 页面的子页面。要阻止发布这些子页面,请使用 cascade 前置 matter 字段将 构建选项 级联到子页面。

运行 hugo 或 hugo server 时,你可以使用命令行标志覆盖默认行为:

hugo --buildDrafts    # 或 -D
hugo --buildExpired   # 或 -E
hugo --buildFuture    # 或 -F

尽管你也可以在你的站点配置中设置这些值,但这可能会导致意外结果,除非所有内容作者都了解并理解这些设置。

如上所述,Hugo 在构建你的网站之前不会清除 public 目录。根据上述四个条件的 当前 评估结果,构建后你的 public 目录可能包含来自先前构建的额外文件。

一个常见的做法是在每次构建之前手动清除 public 目录的内容,以删除草稿、过期和未来的内容。

开发和测试你的网站

要在开发布局或创建内容时查看你的网站, cd 到你的项目目录并运行:

hugo server

hugo server 命令构建你的网站并使用一个最小的 HTTP 服务器提供你的页面。当你运行 hugo server 时,它将显示你本地站点的 URL:

Web Server is available at http://localhost:1313/ 

服务器运行时,它会监视你的项目目录中资产、配置、内容、数据、布局、翻译和静态文件的更改。当它检测到更改时,服务器会重新构建你的网站并使用 LiveReload 刷新你的浏览器。

大多数 Hugo 构建速度非常快,除非你直接查看浏览器,否则你可能不会注意到更改。

LiveReload

服务器运行时,Hugo 会将 JavaScript 注入生成的 HTML 页面。LiveReload 脚本通过 WebSockets 创建浏览器与服务器之间的连接。你不需要安装任何软件或浏览器插件,也不需要任何配置。

自动重定向

编辑内容时,如果希望浏览器自动重定向到上次修改的页面,请运行:

hugo server --navigateToChanged

部署你的网站

如上所述,Hugo 在构建你的网站之前不会清除 public 目录。在每次构建之前手动清除 public 目录的内容,以删除草稿、过期和未来的内容。

当你准备好部署你的网站时,运行:

hugo

这将构建你的网站,并将文件发布到 public 目录。目录结构将如下所示:

public/
├── categories/
│   ├── index.html
│   └── index.xml  <-- 此部分的 RSS feed
├── posts/
│   ├── my-first-post/
│   │   └── index.html
│   ├── index.html
│   └── index.xml  <-- 此部分的 RSS feed
├── tags/
│   ├── index.html
│   └── index.xml  <-- 此部分的 RSS feed
├── index.html
├── index.xml      <-- 站点的 RSS feed
└── sitemap.xml

在一个简单的托管环境中,你通常将文件 ftp 、 rsync 或 scp 到虚拟主机的根目录, public 目录的内容是你所需要的一切。

我们的大多数用户使用 CI/CD 工作流程部署他们的站点,其中对他们的 GitHub 或 GitLab 存储库的推送 1(The) 会触发构建和部署。流行的提供商包括 AWS Amplify 、 CloudCannon 、 Cloudflare Pages 、 GitHub Pages 、 GitLab Pages 和 Netlify 。

在 托管和部署 部分了解更多信息。


  1. Git 存储库包含整个项目目录,通常不包括 public 目录,因为站点是在推送 之后 构建的。 ↩︎

See also

  • 日志记录

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 管道
  • 命令行界面
  • 故障排除
  • 开发者工具
  • 托管和部署
  • 贡献
  • 维护