HUGO

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
gohugoio 加星
  • 关于
    • 本节内容
    • 简介
    • 特性
    • 隐私
    • 安全
    • 许可
  • 安装
    • 本节内容
    • macOS
    • Linux
    • Windows
    • BSD
  • 入门指南
    • 本节内容
    • 快速开始
    • 基本用法
    • 目录结构
    • 配置
    • 配置标记
    • 配置构建
    • 术语表
    • 外部学习资源
  • 快速参考
    • 本节内容
    • 表情符号
    • 函数
    • 方法
    • 页面集合
  • 内容管理
    • 本节内容
    • 组织
    • 页面包
    • 内容格式
    • 前言
    • 构建选项
    • 页面资源
    • 图像处理
    • 短代码
    • 相关内容
    • 章节
    • 内容类型
    • 原型
    • 分类
    • 摘要
    • 链接和交叉引用
    • URL 管理
    • 菜单
    • 评论
    • 多语言
    • Markdown 属性
    • 语法高亮
    • 图表
    • 数学
    • 数据源
    • 内容适配器
  • 模板
    • 本节内容
    • 简介
    • 模板类型
    • 查找顺序
    • 基础模板
    • 主页模板
    • 单页模板
    • 章节模板
    • 分类模板
    • 术语模板
    • 局部模板
    • 内容视图模板
    • 短代码模板
    • 站点地图模板
    • RSS 模板
    • 404 模板
    • robots.txt 模板
    • 菜单
    • 分页
    • 嵌入式模板
    • 自定义输出格式
  • 函数
    • 本节内容
    • cast
    • collections
    • compare
    • crypto
    • css
    • data
    • debug
    • diagrams
    • encoding
    • fmt
    • global
    • go template
    • hash
    • hugo
    • images
    • inflect
    • js
    • lang
    • math
    • openapi3
    • os
    • partials
    • path
    • reflect
    • resources
    • safe
    • strings
    • templates
    • time
    • transform
    • urls
  • 方法
    • 本节内容
    • Duration
    • Menu
    • 菜单项
    • 页面
    • 分页器
    • 页面集合
    • 资源
    • 短代码
    • 站点
    • 分类
    • 时间
  • 渲染钩子
    • 本节内容
    • 简介
    • 块引用
    • 代码块
    • 标题
    • 图片
    • 链接
    • 透传
    • 表格
  • 短代码
    • 本节内容
    • 评论
    • 详情
    • 图例
    • Gist
    • 高亮
    • Instagram
    • 参数
    • 二维码
    • Ref
    • Relref
    • Vimeo
    • X
    • YouTube
  • Hugo 模块
    • 本节内容
    • 配置 Hugo 模块
    • 使用 Hugo 模块
    • 主题组件
  • Hugo 管道
    • 本节内容
    • 简介
    • 将 Sass 转译为 CSS
    • PostCSS
    • 后期处理
    • JavaScript 构建
    • 资源最小化
    • 连接资源
    • 指纹识别和 SRI 哈希
    • 从字符串获取资源
    • 从模板获取资源
  • CLI
  • 问题排查
    • 本节内容
    • 审计
    • 日志
    • 检查
    • 弃用
    • 性能
    • 常见问题
  • 开发者工具
    • 本节内容
    • 编辑器插件
    • 前端
    • 搜索
    • 迁移
    • 其他项目
  • 托管和部署
    • 本节内容
    • Hugo 部署
    • 使用 Rclone 部署
    • 使用 Rsync 部署
    • 在 21YunBox 上托管
    • 在 AWS Amplify 上托管
    • 在 Azure Static Web Apps 上托管
    • 在 Cloudflare Pages 上托管
    • 在 Firebase 上托管
    • 在 GitHub Pages 上托管
    • 在 GitLab Pages 上托管
    • 在 KeyCDN 上托管
    • 在 Netlify 上托管
    • 在 Render 上托管
  • 贡献
    • 本节内容
    • 开发
    • 文档
    • 主题
  • 维护
入门指南

基本用法

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 允许您在内容的 前言 中设置 draft、date、publishDate 和 expiryDate。默认情况下,当以下情况时,Hugo 不会发布内容:

  • draft 值为 true
  • date 是未来时间
  • publishDate 是未来时间
  • expiryDate 是过去时间
v0.123.0 中的新增功能

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

您可以使用命令行标志覆盖运行 hugo 或 hugo server 时的默认行为

hugo --buildDrafts    # or -D
hugo --buildExpired   # or -E
hugo --buildFuture    # or -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 脚本通过 Web Socket 创建从浏览器到服务器的连接。您不需要安装任何软件或浏览器插件,也不需要任何配置。

自动重定向

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

hugo server --navigateToChanged

部署您的站点

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

当您准备好部署您的站点时,运行

hugo

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

public/
├── categories/
│   ├── index.html
│   └── index.xml  <-- RSS feed for this section
├── posts/
│   ├── my-first-post/
│   │   └── index.html
│   ├── index.html
│   └── index.xml  <-- RSS feed for this section
├── tags/
│   ├── index.html
│   └── index.xml  <-- RSS feed for this section
├── index.html
├── index.xml      <-- RSS feed for the site
└── sitemap.xml

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

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

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


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

另请参阅

  • 外部学习资源
  • 日志
  • 快速开始

在本页中

  • 测试您的安装
  • 显示可用命令
  • 构建您的站点
  • 草稿、未来和过期内容
  • 开发和测试您的站点
  • 部署您的站点
最后更新:2025 年 1 月 16 日:将目录名、文件名和文件路径格式化为代码 (8051ff818)
改进此页面
由 Hugo 作者
Hugo Logo
  • 提交问题
  • 获取帮助
  • @GoHugoIO
  • @spf13
  • @bepsays

Netlify badge

 

Hugo 赞助商

您的公司?
 

Hugo 徽标的版权归 Steve Francia 2013–2025 所有。

Hugo Gopher 基于 Renée French 的原创作品。

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
  • 关于
  • 安装
  • 入门指南
  • 快速参考
  • 内容管理
  • 模板
  • 函数
  • 方法
  • 渲染钩子
  • 短代码
  • Hugo 模块
  • Hugo 管道
  • CLI
  • 问题排查
  • 开发者工具
  • 托管和部署
  • 贡献
  • 维护