基本用法
测试您的安装
在安装 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 # or -D
hugo --buildExpired # or -E
hugo --buildFuture # or -F
虽然您也可以在站点配置中设置这些值,但除非所有内容作者都了解并理解这些设置,否则可能会导致意外的结果。
开发和测试您的站点
要查看您的站点,以便在开发布局或创建内容时使用,请cd
进入您的项目目录并运行:
hugo server
hugo server
命令将您的站点构建到内存中,并使用一个最小的 HTTP 服务器为您提供服务。当您运行hugo server
时,它将显示您本地站点的 URL:
Web Server is available at https://127.0.0.1:1313/
服务器运行时,它会监视您的项目目录中对资源、配置、内容、数据、布局、翻译和静态文件的更改。当它检测到更改时,服务器会重新构建您的站点并使用LiveReload刷新您的浏览器。
大多数 Hugo 构建速度非常快,除非您直接查看浏览器,否则您可能不会注意到更改。
LiveReload
服务器运行时,Hugo 会将 JavaScript 注入生成的 HTML 页面中。LiveReload 脚本通过 Web 套接字在浏览器和服务器之间创建连接。您无需安装任何软件或浏览器插件,也不需要任何配置。
自动重定向
在编辑内容时,如果您希望浏览器自动重定向到您上次修改的页面,请运行
hugo server --navigateToChanged
部署您的网站
当您准备好部署您的网站时,请运行
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 工作流部署他们的网站,其中对 GitHub 或 GitLab 存储库的推送1 会触发构建和部署。流行的提供商包括 AWS Amplify、CloudCannon、Cloudflare Pages、GitHub Pages、GitLab Pages 和 Netlify。
在 托管和部署 部分了解更多信息。
-
Git 存储库包含整个项目目录,通常不包括 public 目录,因为网站是在推送之后构建的。 ↩︎