基本用法
测试你的安装
在 安装 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 允许你设置内容 前置 matter 中的 draft
、 date
、 publishDate
和 expiryDate
。默认情况下,Hugo 不会发布内容,如果:
draft
值为true
date
在未来publishDate
在未来expiryDate
在过去
运行 hugo
或 hugo server
时,你可以使用命令行标志覆盖默认行为:
hugo --buildDrafts # 或 -D
hugo --buildExpired # 或 -E
hugo --buildFuture # 或 -F
尽管你也可以在你的站点配置中设置这些值,但这可能会导致意外结果,除非所有内容作者都了解并理解这些设置。
开发和测试你的网站
要在开发布局或创建内容时查看你的网站, 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/
├── 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 。
在 托管和部署 部分了解更多信息。
-
Git 存储库包含整个项目目录,通常不包括 public 目录,因为站点是在推送 之后 构建的。 ↩︎