From 1de2bc5a90dd099ec566351e98340dcb81a61a0f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Tue, 20 Dec 2022 17:03:25 +0100 Subject: [PATCH 01/16] config: Update to ga v4 --- config/_default/config.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config/_default/config.toml b/config/_default/config.toml index f4965dff1..731233310 100644 --- a/config/_default/config.toml +++ b/config/_default/config.toml @@ -1,7 +1,7 @@ baseURL = "https://gohugo.io/" defaultContentLanguage = "en" enableEmoji = true -googleAnalytics = "UA-7131036-4" +googleAnalytics = "G-MBZGKNMDWC" ignoreErrors = ["error-remote-getjson", "error-missing-instagram-accesstoken"] languageCode = "en-us" paginate = 100 From 808aee6f64c410ba6629d25155b1eb2a57ed2bbb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Tue, 20 Dec 2022 17:03:25 +0100 Subject: [PATCH 02/16] config: Update to ga v4 --- hugo.work | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 hugo.work diff --git a/hugo.work b/hugo.work new file mode 100644 index 000000000..a3c91ef28 --- /dev/null +++ b/hugo.work @@ -0,0 +1,4 @@ +go 1.19 + +use . +use ../gohugoioTheme From 4e66d98adf877b932eeb4138a0f9190c748a7a3f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Tue, 20 Dec 2022 17:08:57 +0100 Subject: [PATCH 03/16] Update theme --- .../layouts/_default/baseof.html | 166 +++++++++++------- _vendor/modules.txt | 2 +- go.mod | 2 +- go.sum | 2 + 4 files changed, 109 insertions(+), 63 deletions(-) diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/_default/baseof.html b/_vendor/github.com/gohugoio/gohugoioTheme/layouts/_default/baseof.html index 04261a886..d8e7dc014 100644 --- a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/_default/baseof.html +++ b/_vendor/github.com/gohugoio/gohugoioTheme/layouts/_default/baseof.html @@ -1,75 +1,119 @@ - - - - - {{/* https://www.zachleat.com/web/preload/ */}} - - - - - - {{/* NOTE: the Site's title, and if there is a page title, that is set too */}} - {{ block "title" . }}{{ with .Title }}{{ . }} | {{ end }}{{ .Site.Title }}{{ end }} - - - {{ hugo.Generator }} - - {{ if eq (getenv "HUGO_ENV") "production" | or (eq .Site.Params.env "production") }} - + + en-us {{ end }} + "> + + + {{/* https://www.zachleat.com/web/preload/ */}} + + + - {{ range .AlternativeOutputFormats -}} - - {{ end -}} + + {{/* NOTE: the Site's title, and if there is a page title, that is set too */}} + + {{ block "title" . }} + {{ with .Title }}{{ . }} |{{ end }}{{ .Site.Title }} + {{ end }} - {{ $isDev := eq hugo.Environment "development" }} - {{ $stylesheet := resources.Get "output/css/app.css" }} - {{ if not $isDev }} - {{ $stylesheet = $stylesheet | minify | fingerprint }} - {{ end }} - {{ with $stylesheet }} - {{ if $isDev }} - <link rel="stylesheet" href="{{ .RelPermalink }}" crossorigin="anonymous"> - {{ else }} - <link rel="stylesheet" href="{{ .RelPermalink }}" integrity="{{ .Data.Integrity }}" crossorigin="anonymous"> - {{ end }} - {{ $.Scratch.Set "stylesheet" . }} - {{end}} + - + + {{ hugo.Generator }} - {{ block "scripts" . }} - {{- partial "site-scripts.html" . -}} - {{ end }} - {{ partial "site-manifest.html" . }} - {{- partial "head-additions.html" . -}} - {{- partial "opengraph/opengraph.html" . -}} - {{- template "_internal/schema.html" . -}} - {{- partial "opengraph/twitter_cards.html" . -}} + {{ if hugo.IsProduction }} + + {{ else }} + + {{ end }} - {{ if eq (getenv "HUGO_ENV") "production" | or (eq .Site.Params.env "production") }} - {{ partial "gtag" . }} - {{ end }} + {{ range .AlternativeOutputFormats -}} + + {{ end -}} - + {{ $isDev := eq hugo.Environment "development" }} + {{ $stylesheet := resources.Get "output/css/app.css" }} + {{ if not $isDev }} + {{ $stylesheet = $stylesheet | minify | fingerprint }} + {{ end }} + {{ with $stylesheet }} + {{ if $isDev }} + + {{ else }} + + {{ end }} + {{ $.Scratch.Set "stylesheet" . }} + {{ end }} - - {{ partial "hooks/after-body-start" . }} - {{ block "nav" . }}{{ partial "site-nav.html" . }}{{ end }} - {{ block "header" . }}{{ end }} -
- {{ block "main" . }}{{ end }} -
- {{ block "footer" . }}{{ partialCached "site-footer.html" . }}{{ end }} - - {{ partial "hooks/before-body-end" . }} - + - + {{ block "scripts" . }} + {{- partial "site-scripts.html" . -}} + {{ end }} + {{ partial "site-manifest.html" . }} + {{- partial "head-additions.html" . -}} + {{- partial "opengraph/opengraph.html" . -}} + {{- template "_internal/schema.html" . -}} + {{- partial "opengraph/twitter_cards.html" . -}} + {{ if hugo.IsProduction }} + {{ partial "gtag" . }} + {{ end }} + + + + + {{ partial "hooks/after-body-start" . }} + {{ block "nav" . }}{{ partial "site-nav.html" . }}{{ end }} + {{ block "header" . }}{{ end }} +
+ {{ block "main" . }}{{ end }} +
+ + {{ block "footer" . }}{{ partialCached "site-footer.html" . }}{{ end }} + + {{ partial "hooks/before-body-end" . }} + + diff --git a/_vendor/modules.txt b/_vendor/modules.txt index 787da8ac2..fff8a6dfe 100644 --- a/_vendor/modules.txt +++ b/_vendor/modules.txt @@ -1 +1 @@ -# github.com/gohugoio/gohugoioTheme v0.0.0-20221217122332-1c1752ad8f14 +# github.com/gohugoio/gohugoioTheme v0.0.0-20221220160735-8ffa1ef883b6 diff --git a/go.mod b/go.mod index 6f4856f66..fbf5b5b89 100644 --- a/go.mod +++ b/go.mod @@ -2,4 +2,4 @@ module github.com/gohugoio/hugoDocs go 1.16 -require github.com/gohugoio/gohugoioTheme v0.0.0-20221217122332-1c1752ad8f14 // indirect +require github.com/gohugoio/gohugoioTheme v0.0.0-20221220160735-8ffa1ef883b6 // indirect diff --git a/go.sum b/go.sum index 465e50591..5a3d939b4 100644 --- a/go.sum +++ b/go.sum @@ -49,3 +49,5 @@ github.com/gohugoio/gohugoioTheme v0.0.0-20221206093948-1408550ab675 h1:wjpYa1cT github.com/gohugoio/gohugoioTheme v0.0.0-20221206093948-1408550ab675/go.mod h1:kpw3SS48xZvLQGEXKu8u5XHgXkPvL8DX3oGa07+z8Bs= github.com/gohugoio/gohugoioTheme v0.0.0-20221217122332-1c1752ad8f14 h1:K6tPFpi7W0zb89QIf+lNdgdTXfDFemU6NKk46MlX9lQ= github.com/gohugoio/gohugoioTheme v0.0.0-20221217122332-1c1752ad8f14/go.mod h1:kpw3SS48xZvLQGEXKu8u5XHgXkPvL8DX3oGa07+z8Bs= +github.com/gohugoio/gohugoioTheme v0.0.0-20221220160735-8ffa1ef883b6 h1:yEoQecRBoLGfc7yTybMD3Mhm03bTScZFYPvwe0p75vA= +github.com/gohugoio/gohugoioTheme v0.0.0-20221220160735-8ffa1ef883b6/go.mod h1:GOYeAPQJ/ok8z7oz1cjfcSlsFpXrmx6VkzQ5RpnyhZM= From 12edd7363c7a58942b97969f4c4d032941a9dc7b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Tue, 20 Dec 2022 15:10:55 +0100 Subject: [PATCH 04/16] Add some docs for workspaces --- README.md | 9 ++++++++ content/en/hugo-modules/use-modules.md | 30 ++++++++++++++++++++++++++ hugo.work | 4 ++++ 3 files changed, 43 insertions(+) create mode 100644 hugo.work diff --git a/README.md b/README.md index 072714a02..730ad5fc8 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,15 @@ Spelling fixes are most welcomed, and if you want to contribute longer sections * For example, try to find short snippets that teaches people about the concept. If the example is also useful as-is (copy and paste), then great. Don't list long and similar examples just so people can use them on their sites. * Hugo has users from all over the world, so easy to understand and [simple English](https://simple.wikipedia.org/wiki/Basic_English) is good. + +## Edit the theme + +If you want to do docs-related theme changes, the simplest way is to have both `hugoDocs` and `gohugoioTheme` cloned as sibling directories, and then run: + +``` +HUGO_MODULE_WORKSPACE=hugo.work hugo server --ignoreVendorPaths "**" +``` + ## Branches * The `master` branch is where the site is automatically built from, and is the place to put changes relevant to the current Hugo version. diff --git a/content/en/hugo-modules/use-modules.md b/content/en/hugo-modules/use-modules.md index 8870307b3..977a52bd6 100644 --- a/content/en/hugo-modules/use-modules.md +++ b/content/en/hugo-modules/use-modules.md @@ -135,3 +135,33 @@ Run `hugo mod clean` to delete the entire modules cache. Note that you can also configure the `modules` cache with a `maxAge`, see [File Caches](/getting-started/configuration/#configure-file-caches). Also see the [CLI Doc](/commands/hugo_mod_clean/). + +## Module Workspaces + +{{< new-in "0.109.0" >}} + +Workspace support was added in [Go 1.18](https://go.dev/blog/get-familiar-with-workspaces) and Hugo got solid support for it in the `v0.109.0` version. + +A common use case for a workspace is to simplify local development of a site with its theme modules. + +A workspace can be configured in a `*.work` file and activated with the [module.workspace](/hugo-modules/configuration/) setting, which for this use is commonly controlled via the `HUGO_MODULE_WORKSPACE` OS environment variable. + +See the [hugo.work](https://github.com/gohugoio/hugo/blob/master/hugo.work) file in the Hugo Docs repo for an example: + +``` +go 1.19 + +use . +use ../gohugoioTheme +``` + +Using the `use` directive, list all the modules you want to work on, pointing to its relative location. As in the example above, it's recommended to always include the main project (the ".") in the list. + +With that you can start the Hugo server with that workspace enabled: + +``` +HUGO_MODULE_WORKSPACE=hugo.work hugo server --ignoreVendorPaths "**" +``` + +The `--ignoreVendorPaths` flag is added above to ignore any of the vendored dependencies inside `_vendor`. If you don't use vendoring, you don't need that flag. But now the server is set up watching the files and directories in the workspace and you can see your local edits reloaded. + diff --git a/hugo.work b/hugo.work new file mode 100644 index 000000000..a3c91ef28 --- /dev/null +++ b/hugo.work @@ -0,0 +1,4 @@ +go 1.19 + +use . +use ../gohugoioTheme From d034175ca61de65ce5b5bcbe430bc5dedead8613 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Fri, 23 Dec 2022 12:12:19 +0100 Subject: [PATCH 05/16] netlify: Hugo 0.109.0 --- netlify.toml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/netlify.toml b/netlify.toml index 51c25ef3c..4a1e79e8c 100644 --- a/netlify.toml +++ b/netlify.toml @@ -3,7 +3,7 @@ publish = "public" command = "hugo --gc --minify" [context.production.environment] -HUGO_VERSION = "0.108.0" +HUGO_VERSION = "0.109.0" HUGO_ENV = "production" HUGO_ENABLEGITINFO = "true" @@ -11,20 +11,20 @@ HUGO_ENABLEGITINFO = "true" command = "hugo --gc --minify --enableGitInfo" [context.split1.environment] -HUGO_VERSION = "0.108.0" +HUGO_VERSION = "0.109.0" HUGO_ENV = "production" [context.deploy-preview] command = "hugo --gc --minify --buildFuture -b $DEPLOY_PRIME_URL" [context.deploy-preview.environment] -HUGO_VERSION = "0.108.0" +HUGO_VERSION = "0.109.0" [context.branch-deploy] command = "hugo --gc --minify -b $DEPLOY_PRIME_URL" [context.branch-deploy.environment] -HUGO_VERSION = "0.108.0" +HUGO_VERSION = "0.109.0" [context.next.environment] HUGO_ENABLEGITINFO = "true" From af0014e1469f2e90b3046a52d65fcf859313297f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Fri, 23 Dec 2022 12:20:04 +0100 Subject: [PATCH 06/16] Update scss-sass.md --- content/en/hugo-pipes/scss-sass.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/content/en/hugo-pipes/scss-sass.md b/content/en/hugo-pipes/scss-sass.md index 169c473d2..4e39207fa 100755 --- a/content/en/hugo-pipes/scss-sass.md +++ b/content/en/hugo-pipes/scss-sass.md @@ -29,6 +29,9 @@ transpiler [string] targetPath [string] : If not set, the resource's target path will be the asset file original path with its extension replaced by `.css`. +vars [map] +: Map of key/value pairs that will be available in the `hugo:vars` namespace, e.g. with `@use "hugo:vars" as v;` or (globally) with `@import "hugo:vars";` {{< new-in "0.109.0" >}} + outputStyle [string] : Default is `nested` (LibSass) and `expanded` (Dart Sass). Other available output styles for LibSass are `expanded`, `compact` and `compressed`. Dart Sass only supports `expanded` and `compressed`. From aca440052e6e28b2e90f48da230258153d291bc0 Mon Sep 17 00:00:00 2001 From: Karl Keefer Date: Sat, 24 Dec 2022 05:56:26 -0800 Subject: [PATCH 07/16] rm Forestry - facing end-of-life shortly (#1944) --- content/en/tools/frontends.md | 1 - 1 file changed, 1 deletion(-) diff --git a/content/en/tools/frontends.md b/content/en/tools/frontends.md index 9f52c4c67..7ad44df53 100644 --- a/content/en/tools/frontends.md +++ b/content/en/tools/frontends.md @@ -26,5 +26,4 @@ toc: false ## Commercial Services - [DATOCMS](https://www.datocms.com) DatoCMS is a fully customizable administrative area for your static websites. Use your favorite website generator, let your clients publish new content independently, and the host the site anywhere you like. -- [Forestry.io](https://forestry.io/). Forestry is a git-backed CMS for Hugo, Gatsby, Jekyll and VuePress websites with support for GitHub, GitLab, Bitbucket and Azure Devops. Forestry provides a nice user interface to edit and model content for non technical editors. It supports S3, Cloudinary and Netlify Large Media integrations for storing media. Every time an update is made via the CMS, Forestry will commit changes back to your repo and vice-versa. - [CloudCannon](https://cloudcannon.com/hugo-cms/). The intuitive Git-based CMS for your Hugo website. CloudCannon syncs changes from your Git repository and pushes content changes back, so your development and content teams are always in sync. Edit all of your content on the page with visual editing, build entire pages with reusable custom components and then publish confidently. From b3b900f3fcfa1b19800618e086f8dc53ceab4c13 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Sat, 24 Dec 2022 15:46:41 +0100 Subject: [PATCH 08/16] Update introduction.md --- content/en/hugo-pipes/introduction.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/content/en/hugo-pipes/introduction.md b/content/en/hugo-pipes/introduction.md index c16572e48..f38ec5895 100755 --- a/content/en/hugo-pipes/introduction.md +++ b/content/en/hugo-pipes/introduction.md @@ -50,16 +50,6 @@ With `resources.GetRemote`, the first argument is a remote URL: `resources.Get` and `resources.GetRemote` return `nil` if the resource is not found. -## Copy a Resource - -{{< new-in "0.100.0" >}} - -`resources.Copy` allows you to copy almost any Hugo `Resource` (the one exception is the `Page`), possibly most useful for renaming things: - -```go-html-template -{{ $resized := $image.Resize "400x400" | resources.Copy "images/mynewname.jpg" }} - -``` ### Caching @@ -119,6 +109,18 @@ You can also change the request method and set the request body: Remote resources fetched with `resources.GetRemote` will be cached on disk. See [Configure File Caches](/getting-started/configuration/#configure-file-caches) for details. + +## Copy a Resource + +{{< new-in "0.100.0" >}} + +`resources.Copy` allows you to copy almost any Hugo `Resource` (the one exception is the `Page`), possibly most useful for renaming things: + +```go-html-template +{{ $resized := $image.Resize "400x400" | resources.Copy "images/mynewname.jpg" }} + +``` + ## Asset directory Asset files must be stored in the asset directory. This is `/assets` by default, but can be configured via the configuration file's `assetDir` key. From 3a22ee7d6e7716587864f8d9cab0b58f8dbf8c08 Mon Sep 17 00:00:00 2001 From: Joe Mooring Date: Thu, 29 Dec 2022 22:31:26 -0800 Subject: [PATCH 09/16] Remove translations The english content remains in content/en. --- config/_default/languages.toml | 14 +-- config/_default/menus/menus.zh.toml | 121 ---------------------- content/zh/_index.md | 49 --------- content/zh/about/_index.md | 20 ---- content/zh/content-management/_index.md | 20 ---- content/zh/documentation.md | 21 ---- content/zh/news/_index.md | 4 - content/zh/templates/_index.md | 19 ---- content/zh/templates/base.md | 131 ------------------------ content/zh/tools/_index.md | 25 ----- content/zh/tools/search.md | 31 ------ 11 files changed, 4 insertions(+), 451 deletions(-) delete mode 100644 config/_default/menus/menus.zh.toml delete mode 100644 content/zh/_index.md delete mode 100644 content/zh/about/_index.md delete mode 100644 content/zh/content-management/_index.md delete mode 100644 content/zh/documentation.md delete mode 100644 content/zh/news/_index.md delete mode 100644 content/zh/templates/_index.md delete mode 100644 content/zh/templates/base.md delete mode 100644 content/zh/tools/_index.md delete mode 100644 content/zh/tools/search.md diff --git a/config/_default/languages.toml b/config/_default/languages.toml index c9914d84d..cfddb5398 100644 --- a/config/_default/languages.toml +++ b/config/_default/languages.toml @@ -1,10 +1,4 @@ - - [en] - contentDir = "content/en" - languageName = "English" - weight = 1 - - [zh] - contentDir = "content/zh" - languageName = "中文" - weight = 2 +[en] +contentDir = "content/en" +languageName = "English" +weight = 1 diff --git a/config/_default/menus/menus.zh.toml b/config/_default/menus/menus.zh.toml deleted file mode 100644 index 2f68be67b..000000000 --- a/config/_default/menus/menus.zh.toml +++ /dev/null @@ -1,121 +0,0 @@ - -# Chinese menus - -[[docs]] - name = "关于 Hugo" - weight = 1 - identifier = "about" - url = "/zh/about/" - -[[docs]] - name = "入门" - weight = 5 - identifier = "getting-started" - url = "/zh/getting-started/" - -[[docs]] - name = "主题" - weight = 15 - identifier = "themes" - post = "break" - url = "/zh/themes/" - -# Core languages.zh.menus - -[[docs]] - name = "内容管理" - weight = 20 - identifier = "content-management" - post = "expanded" - url = "/zh/content-management/" - -[[docs]] - name = "模板" - weight = 25 - identifier = "templates" - url = "/zh/templates/" - -[[docs]] - name = "函数" - weight = 30 - identifier = "functions" - url = "/zh/functions/" - -[[docs]] - name = "变量" - weight = 35 - identifier = "variables" - url = "/zh/variables/" - -[[docs]] - name = "CLI" - weight = 40 - post = "break" - identifier = "commands" - url = "/commands/" - -# LOW LEVEL ITEMS -[[docs]] - name = "故障排除" - weight = 60 - identifier = "troubleshooting" - url = "/zh/troubleshooting/" - -[[docs]] - name = "工具" - weight = 70 - identifier = "tools" - url = "/zh/tools/" - -[[docs]] - name = "托管与部署" - weight = 80 - identifier = "hosting-and-deployment" - url = "/zh/hosting-and-deployment/" - -[[docs]] - name = "贡献" - weight = 100 - post = "break" - identifier = "contribute" - url = "/zh/contribute/" - -[[global]] - name = "新闻" - weight = 1 - identifier = "news" - url = "/zh/news/" - -[[global]] - name = "文档" - weight = 5 - identifier = "docs" - url = "/zh/documentation/" - -[[global]] - name = "主题" - weight = 10 - identifier = "themes" - url = "https://themes.gohugo.io/" - -[[global]] - name = "作品展示" - weight = 20 - identifier = "showcase" - url = "/zh/showcase/" - -# Anything with a weight > 100 gets an external icon -[[global]] - name = "社区" - weight = 150 - icon = true - identifier = "community" - post = "external" - url = "https://discourse.gohugo.io/" - -[[global]] - name = "GitHub" - weight = 200 - identifier = "github" - post = "external" - url = "https://github.com/gohugoio/hugo" diff --git a/content/zh/_index.md b/content/zh/_index.md deleted file mode 100644 index d54cb3436..000000000 --- a/content/zh/_index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "世界上最快的网站构建框架" -date: 2017-03-02T12:00:00-05:00 -features: - - heading: 飞快的速度 - image_path: /images/icon-fast.svg - tagline: 摩登发布 - copy: Hugo 是同类中最快的工具。生成一页小于 1ms，生成一个站点平均不超过 1s。 - - - heading: 强大的内容管理 - image_path: /images/icon-content-management.svg - tagline: 灵活的规则。Hugo 是一个设计师的梦想。 - copy: Hugo 支持无限的内容类型、分类、菜单、动态 API 驱动的内容，以及更多，都不需要插件。 - - - heading: 短代码 - image_path: /images/icon-shortcodes.svg - tagline: Hugo 短代码是 Markdown 隐藏的强大功能。 - copy: 我们喜欢美丽简洁的 markdown 语法，但是有时候我们也想要更灵活一些。Hugo 短代码允许既美丽又灵活。 - - - heading: 内置模板 - image_path: /images/icon-built-in-templates.svg - tagline: Hugo 有通用的模式让你快速的完成工作。 - copy: Hugo 平台预置的模板会快速实现搜索引擎优化、评论、分析和其他的功能。一行代码，你就完成了。 - - - heading: 多语言和国际化 - image_path: /images/icon-multilingual2.svg - tagline: 多语言制作 - copy: Hugo 为多语言站点提供了完整的国际化支持，并且具有与 Hugo 用户在单语言站点中喜爱的相同的简单开发体验。 - - - heading: 自定义输出 - image_path: /images/icon-custom-outputs.svg - tagline: HTML 不够用吗？ - copy: Hugo 允许您以多种格式输出内容，包括 JSON 或 AMP，并且可以很容易地创建自己的内容。 -sections: - - heading: "100 多个主题" - cta: 看看 Hugo 的主题 - link: https://themes.gohugo.io/ - color_classes: bg-accent-color white - image: /images/homepage-screenshot-hugo-themes.jpg - copy: "Hugo 提供了一个强大的主题系统，易于实现，但能够生成即使是最复杂的网站。" - - heading: "功能模板" - cta: 开始吧。 - link: templates/ - color_classes: bg-primary-color-light black - image: /images/home-page-templating-example.png - copy: "Hugo 基于 Go 的模板提供了恰当的方法来生成从简单到复杂的任何东西。如果你喜欢 Jade/Pug 类似的语法，你也可以使用 Amber、Ace 或三种任意组合。" ---- - -Hugo 是最受欢迎的开源静态站点生成器之一。凭借惊人的速度和灵活性，Hugo 使建设网站的乐趣再现。 diff --git a/content/zh/about/_index.md b/content/zh/about/_index.md deleted file mode 100644 index bf19807d9..000000000 --- a/content/zh/about/_index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: 关于 Hugo -linktitle: 概览 -description: Hugo 的特色、规划、许可和动力。 -date: 2018-04-26 -publishdate: 2018-04-26 -lastmod: 2018-04-26 -categories: [] -keywords: [] -menu: - docs: - parent: "about" - weight: 1 -weight: 1 -draft: false -aliases: [/about-hugo/,/docs/] -toc: false ---- - -Hugo 不是一般的静态网站生成器。 diff --git a/content/zh/content-management/_index.md b/content/zh/content-management/_index.md deleted file mode 100644 index 2f4b198c1..000000000 --- a/content/zh/content-management/_index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: 内容管理 -linkTitle: 内容管理概览 -description: Hugo 可以管理大型的静态网站，支持骨架、内容类型、菜单、引用、概要等等。 -date: 2018-04-23 -publishdate: 2018-04-23 -lastmod: 2018-04-23 -menu: - docs: - parent: content-management - weight: 1 -keywords: [source, organization] -categories: [content management] -weight: 01 #rem -aliases: [/content/,/content/organization] -toc: false -isCJKLanguage: true ---- - -一个实用的静态网站生成器，需要超越“文件头” (front matter) 和模板的等基本功能，才能兼备可伸缩性和可管理性，满足用户所需。Hugo 不仅是给开发者设计的，也同样适用于内容管理员和写作人员。 diff --git a/content/zh/documentation.md b/content/zh/documentation.md deleted file mode 100644 index 1575fd375..000000000 --- a/content/zh/documentation.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Hugo 说明文档 -linktitle: Hugo -description: Hugo 是世界上最快的静态网站引擎。它是用 Go (即 Golang) 编程语言所写成，由 bep、spf13 和朋友们共同开发。 -date: 2017-02-01 -publishdate: 2017-02-01 -menu: - main: - parent: "section name" - weight: 01 -weight: 01 #rem -draft: false -slug: -aliases: [] -toc: false -layout: documentation-home -isCJKLanguage: true ---- -Hugo 是世界上最快的静态网站引擎。它是用 Go (即 Golang) 编程语言所写成，由 [bep](https://github.com/bep)、[spf13](https://github.com/spf13) 和[朋友们](https://github.com/gohugoio/hugo/graphs/contributors)共同开发。 - -下面是我们说明文档中最常用和实用的章节： diff --git a/content/zh/news/_index.md b/content/zh/news/_index.md deleted file mode 100644 index 286d32e19..000000000 --- a/content/zh/news/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: "Hugo 新闻" -aliases: [/release-notes/] ---- diff --git a/content/zh/templates/_index.md b/content/zh/templates/_index.md deleted file mode 100644 index 3cd8df436..000000000 --- a/content/zh/templates/_index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: 模板 Templates -linktitle: 模板概览 -description: Go templating, template types and lookup order, shortcodes, and data. -date: 2017-02-01 -publishdate: 2017-02-01 -lastmod: 2017-02-01 -menu: - docs: - parent: "templates" - weight: 01 -weight: 01 #rem -categories: [templates] -keywords: [] -draft: false -aliases: [/templates/overview/,/templates/content] -toc: false -notesforauthors: ---- diff --git a/content/zh/templates/base.md b/content/zh/templates/base.md deleted file mode 100644 index bf0e9165a..000000000 --- a/content/zh/templates/base.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -title: Base 模板 and Blocks -linktitle: -description: The base and block constructs allow you to define the outer shell of your master templates (i.e., the chrome of the page). -date: 2017-02-01 -publishdate: 2018-08-11 -lastmod: 2017-02-01 -categories: [templates,fundamentals] -keywords: [blocks,base] -menu: - docs: - parent: "templates" - weight: 20 -weight: 20 -sections_weight: 20 -draft: false -aliases: [/templates/blocks/,/templates/base-templates-and-blocks/] -toc: true ---- - -The `block` keyword allows you to define the outer shell of your pages' one or more master template(s) and then fill in or override portions as necessary. - -{{< youtube QVOMCYitLEc >}} - -## Base Template Lookup Order - -The [lookup order][lookup] for base templates is as follows: - -1. `/layouts/section/-baseof.html` -2. `/themes//layouts/section/-baseof.html` -3. `/layouts//baseof.html` -4. `/themes//layouts//baseof.html` -5. `/layouts/section/baseof.html` -6. `/themes//layouts/section/baseof.html` -7. `/layouts/_default/-baseof.html` -8. `/themes//layouts/_default/-baseof.html` -9. `/layouts/_default/baseof.html` -10. `/themes//layouts/_default/baseof.html` - -Variables are denoted by capitalized text set within `<>`. Note that Hugo's default behavior is for `type` to inherit from `section` unless otherwise specified. - -### Example Base Template Lookup Order - -As an example, let's assume your site is using a theme called "mytheme" when rendering the section list for a `posts` section. Hugo picks `layout/section/posts.html` as the template for [rendering the section]. The `{{define}}` block in this template tells Hugo that the template is an extension of a base template. - -Here is the lookup order for the `posts` base template: - -1. `/layouts/section/posts-baseof.html` -2. `/themes/mytheme/layouts/section/posts-baseof.html` -3. `/layouts/posts/baseof.html` -4. `/themes/mytheme/layouts/posts/baseof.html` -5. `/layouts/section/baseof.html` -6. `/themes/mytheme/layouts/section/baseof.html` -7. `/layouts/_default/posts-baseof.html` -8. `/themes/mytheme/layouts/_default/posts-baseof.html` -9. `/layouts/_default/baseof.html` -10. `/themes/mytheme/layouts/_default/baseof.html` - -## Define the Base Template - -The following defines a simple base template at `_default/baseof.html`. As a default template, it is the shell from which all your pages will be rendered unless you specify another `*baseof.html` closer to the beginning of the lookup order. - -{{< code file="layouts/_default/baseof.html" download="baseof.html" >}} - - - - - {{ block "title" . }} - <!-- Blocks may include default content. --> - {{ .Site.Title }} - {{ end }} - - - - {{ block "main" . }} - - {{ end }} - {{ block "footer" . }} - - {{ end }} - - -{{< /code >}} - -## Override the Base Template - -From the above base template, you can define a [default list template][hugolists]. The default list template will inherit all of the code defined above and can then implement its own `"main"` block from: - -{{< code file="layouts/_default/list.html" download="list.html" >}} -{{ define "main" }} -

Posts

- {{ range .Pages }} -
-

{{ .Title }}

- {{ .Content }} -
- {{ end }} -{{ end }} -{{< /code >}} - -This replaces the contents of our (basically empty) "main" block with something useful for the list template. In this case, we didn't define a `"title"` block, so the contents from our base template remain unchanged in lists. - -{{% warning %}} -Code that you put outside the block definitions *can* break your layout. This even includes HTML comments. For example: - -``` - -{{ define "main" }} -...your code here -{{ end }} -``` -[See this thread from the Hugo discussion forums.](https://discourse.gohugo.io/t/baseof-html-block-templates-and-list-types-results-in-empty-pages/5612/6) -{{% /warning %}} - -The following shows how you can override both the `"main"` and `"title"` block areas from the base template with code unique to your [default single page template][singletemplate]: - -{{< code file="layouts/_default/single.html" download="single.html" >}} -{{ define "title" }} - - {{ .Title }} – {{ .Site.Title }} -{{ end }} -{{ define "main" }} -

{{ .Title }}

- {{ .Content }} -{{ end }} -{{< /code >}} - -[hugolists]: /templates/lists -[lookup]: /templates/lookup-order/ -[rendering the section]: /templates/section-templates/ -[singletemplate]: /templates/single-page-templates/ diff --git a/content/zh/tools/_index.md b/content/zh/tools/_index.md deleted file mode 100644 index a3de7dc76..000000000 --- a/content/zh/tools/_index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title:  开发者工具 -linktitle:  开发者工具概览 -description: 除了 Hugo 强大的命令外，对于 Hugo 开发者还有大量社区开发的工具链。 -date: 2018-05-29 -publishdate: 2018-05-29 -lastmod: 2018-05-29 -categories: [developer tools] -keywords: [] -menu: - docs: - parent: "tools" - weight: 01 -weight: 01 -sections_weight: 01 -draft: false -aliases: [/tools/] ---- - -Hugo 最强大的在于它是活跃的——并总在发展的——开发者社区。除了在[语法高亮][syntax] 中提到的 `highlight` 简码外，该章节中的这些工具和其它项目特色都是由商业服务和开源项目提供，很多就是由像你一样的 Hugo 开发者开发的。 - -[查看 Hugo 的流行程度与其它静态网站生成器的比较。][staticgen] - -[staticgen]: https://staticgen.com -[syntax]: /tools/syntax-highlighting/ diff --git a/content/zh/tools/search.md b/content/zh/tools/search.md deleted file mode 100644 index 26b25ea2a..000000000 --- a/content/zh/tools/search.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: 搜索你的 Hugo 网站 -linktitle: 搜索 -description: 为你最新添加的 Hugo 网站看一些开源和商业搜索选择。 -date: 2018-05-29 -publishdate: 2018-05-29 -lastmod: 2018-05-29 -categories: [developer tools] -keywords: [search,tools] -menu: - docs: - parent: "tools" - weight: 60 -weight: 60 -sections_weight: 60 -draft: false -aliases: [] -toc: true ---- - -静态网站还有动态搜索功能？是的。作为可选方案，来自 Google 或者其它搜索引擎的嵌入式脚本，可以给你的访客提供一个自定义的直接基于你的内容文件索引的搜素。 - -* [GitHub Gist for Hugo Workflow](https://gist.github.com/sebz/efddfc8fdcb6b480f567). Gist 包含一个为你的网站创建索引的简单流程。它使用简单的 Grunt 脚本索引你所有的内容文件，并且 [lunr.js](http://lunrjs.com/) 会提供搜索结果。 -* [hugo-lunr](https://www.npmjs.com/package/hugo-lunr). 一个使用 [lunr.js](http://lunrjs.com/) 为你的 Hugo 静态网站添加搜索的简单方法。Hugo-lunr 将会给你的 Hugo 项目中任意 html 和 markdown 文件创建一个索引文件。 -* [hugo-lunr-zh](https://www.npmjs.com/package/hugo-lunr-zh). 有点像 Hugo-lunr，但是 Hugo-lunr-zh 能帮助你分割中文关键字。 -* [Github Gist for Fuse.js integration](https://gist.github.com/eddiewebb/735feb48f50f0ddd65ae5606a1cb41ae). 该 gist 显示如何借助 Hugo 已有的构建时间在客户端通过 [Fuse.js](http://fusejs.io/) 生成可搜索的 JSON 索引。尽管 gist 使用 Fuse.js 进行模糊匹配，任何有能力读取 JSON 索引的客户端工具都可以运行。不需要 Hugo 以外， npm、grunt 或者其它构建时工具。 -* [hugo-search-index](https://www.npmjs.com/package/hugo-search-index). 一个包含实现了搜索的 Gulp 任务和内置浏览器脚本的库。Gulp 从项目中的 markdown 文件生成索引。 - -## 商业搜索服务 - -* [Algolia](https://www.algolia.com/) 的搜索 API 使得在你的应用和网站中提供一个很好的搜索体验变得简单。Algolia 搜索提供托管的全文本、数字化、分面以及地理定位搜索。 From f9d6445c4d5ab9613739cb8589b570d8303ccb2a Mon Sep 17 00:00:00 2001 From: Arun Mani J <49952138+arun-mani-j@users.noreply.github.com> Date: Mon, 2 Jan 2023 12:59:31 +0530 Subject: [PATCH 10/16] Added missing `/` in URL generator (#1946) * Added missing `/` in URL generator In the example to render tags and topics, we use: ```html ``` But this will produce links like `www.example.com/tagsTerm` where `Term` is a tag. So added the missing `/`. * Updated the tags and topics listing code The example previously used the old `with .Params.tags` style. Updated it to use `.GetTerms "tags"` style. --- content/en/templates/single-page-templates.md | 29 ++++++++++--------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/content/en/templates/single-page-templates.md b/content/en/templates/single-page-templates.md index 2b0cfe0e2..925f97b03 100644 --- a/content/en/templates/single-page-templates.md +++ b/content/en/templates/single-page-templates.md @@ -6,7 +6,7 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-04-06 categories: [templates] -keywords: [page,templates] +keywords: [page, templates] menu: docs: parent: "templates" @@ -32,6 +32,7 @@ This single page template makes use of Hugo [base templates], the [`.Format` fun {{< code file="layouts/posts/single.html" download="single.html" >}} {{ define "main" }} +

{{ .Title }}

@@ -46,20 +47,20 @@ This single page template makes use of Hugo [base templates], the [`.Format` fun

{{ .Date.Format "Mon Jan 2, 2006" }}

{{ .WordCount }} Words
- {{ with .Params.topics }} - - {{ end }} - {{ with .Params.tags }} -
    - {{ range . }} -
  • {{ . }}
    • + {{ with .GetTerms "tags" }} + {{ end }} -
- {{ end }}
{{ with .PrevInSection }} @@ -81,7 +82,7 @@ To easily generate new instances of a content type (e.g., new `.md` files in a s [content type]: /content-management/types/ [directory structure]: /getting-started/directory-structure/ [dry]: https://en.wikipedia.org/wiki/Don%27t_repeat_yourself -[`.Format` function]: /functions/format/ +[`.format` function]: /functions/format/ [front matter]: /content-management/front-matter/ [pagetaxonomy]: /templates/taxonomy-templates/#display-a-single-piece-of-contents-taxonomies [pagevars]: /variables/page/ From 1f7094b9e632a36ba56195f463a5212106f23dda Mon Sep 17 00:00:00 2001 From: Josh Payne <59780902+Josh-BI-UK@users.noreply.github.com> Date: Fri, 6 Jan 2023 16:35:56 +0000 Subject: [PATCH 11/16] Correct typo Updates usage.md to correct a small typo on line 123. Changing "When are ready to deploy your site, run:" to "When you are ready to deploy your site, run:". --- content/en/getting-started/usage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/getting-started/usage.md b/content/en/getting-started/usage.md index edf3e82a5..15cf46cbf 100644 --- a/content/en/getting-started/usage.md +++ b/content/en/getting-started/usage.md @@ -120,7 +120,7 @@ hugo server --navigateToChanged As noted above, Hugo does not clear the public directory before building your site. Manually clear the contents of the public directory before each build to remove draft, expired, and future content. {{% /note %}} -When are ready to deploy your site, run: +When you are ready to deploy your site, run: ```bash hugo From 207e7f0a05c78ef76c5d20cd55ba57dc124b6e3e Mon Sep 17 00:00:00 2001 From: Oliver Kamer <3026203+olikami@users.noreply.github.com> Date: Mon, 9 Jan 2023 12:05:32 +0100 Subject: [PATCH 12/16] fix docs for getting remote font Doesn't work with `resources.Get`, need to use `.GetRemote` --- content/en/functions/images/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/functions/images/index.md b/content/en/functions/images/index.md index 0cf45b6ee..e7fc50f7e 100644 --- a/content/en/functions/images/index.md +++ b/content/en/functions/images/index.md @@ -60,7 +60,7 @@ You can load a custom font if needed. Load the font as a Hugo `Resource` and set ```go-html-template -{{ $font := resources.Get "https://github.com/google/fonts/raw/main/apache/roboto/static/Roboto-Black.ttf" }} +{{ $font := resources.GetRemote "https://github.com/google/fonts/raw/main/apache/roboto/static/Roboto-Black.ttf" }} {{ $img := resources.Get "/images/background.png"}} {{ $img = $img.Filter (images.Text "Hugo rocks!" (dict "font" $font From 8b5afdfb47dc4a03a7b2c5e7fc05c99ec4dc2416 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Mon, 9 Jan 2023 13:05:31 +0100 Subject: [PATCH 13/16] Update theme --- .../gohugoio/gohugoioTheme/data/sponsors.toml | 13 +++++++------ .../gohugoioTheme/layouts/_default/baseof.html | 2 +- _vendor/modules.txt | 2 +- go.mod | 2 +- go.sum | 2 ++ 5 files changed, 12 insertions(+), 9 deletions(-) diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/data/sponsors.toml b/_vendor/github.com/gohugoio/gohugoioTheme/data/sponsors.toml index 1e46fc07c..adf26ecdb 100644 --- a/_vendor/github.com/gohugoio/gohugoioTheme/data/sponsors.toml +++ b/_vendor/github.com/gohugoio/gohugoioTheme/data/sponsors.toml @@ -4,12 +4,6 @@ logo = "/images/sponsors/linode-logo_standard_light_medium.png" utm_campaign = "hugosponsor" -[[banners]] - name = "eSolia" - link = "https://esolia.com/post/why-did-esolia-choose-hugo/" - logo = "/images/sponsors/esolia-logo.svg" - utm_campaign = "hugosponsor" - [[banners]] name = "ButterCMS" link = "https://buttercms.com/hugo-cms/" @@ -17,6 +11,13 @@ utm_campaign = "sponsorship" bgcolor = "#131A3E" +[[banners]] + name = "Your Company?" + link = "https://bep.is/en/hugo-sponsor-2023-01/" + logo = "/images/sponsors/your-company.svg" + utm_campaign = "hugosponsor" + bgcolor = "#004887" + #hugohome #hugofooter #hugogithub diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/_default/baseof.html b/_vendor/github.com/gohugoio/gohugoioTheme/layouts/_default/baseof.html index d8e7dc014..5767f078b 100644 --- a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/_default/baseof.html +++ b/_vendor/github.com/gohugoio/gohugoioTheme/layouts/_default/baseof.html @@ -33,7 +33,7 @@ {{/* NOTE: the Site's title, and if there is a page title, that is set too */}} {{ block "title" . }} - {{ with .Title }}{{ . }} |{{ end }}{{ .Site.Title }} + {{ with .Title }}{{ . }} | {{ end }}{{ .Site.Title }} {{ end }} diff --git a/_vendor/modules.txt b/_vendor/modules.txt index fff8a6dfe..21e85264c 100644 --- a/_vendor/modules.txt +++ b/_vendor/modules.txt @@ -1 +1 @@ -# github.com/gohugoio/gohugoioTheme v0.0.0-20221220160735-8ffa1ef883b6 +# github.com/gohugoio/gohugoioTheme v0.0.0-20230109120406-12694c4a9456 diff --git a/go.mod b/go.mod index fbf5b5b89..25975d5c4 100644 --- a/go.mod +++ b/go.mod @@ -2,4 +2,4 @@ module github.com/gohugoio/hugoDocs go 1.16 -require github.com/gohugoio/gohugoioTheme v0.0.0-20221220160735-8ffa1ef883b6 // indirect +require github.com/gohugoio/gohugoioTheme v0.0.0-20230109120406-12694c4a9456 // indirect diff --git a/go.sum b/go.sum index 5a3d939b4..52c3793ca 100644 --- a/go.sum +++ b/go.sum @@ -51,3 +51,5 @@ github.com/gohugoio/gohugoioTheme v0.0.0-20221217122332-1c1752ad8f14 h1:K6tPFpi7 github.com/gohugoio/gohugoioTheme v0.0.0-20221217122332-1c1752ad8f14/go.mod h1:kpw3SS48xZvLQGEXKu8u5XHgXkPvL8DX3oGa07+z8Bs= github.com/gohugoio/gohugoioTheme v0.0.0-20221220160735-8ffa1ef883b6 h1:yEoQecRBoLGfc7yTybMD3Mhm03bTScZFYPvwe0p75vA= github.com/gohugoio/gohugoioTheme v0.0.0-20221220160735-8ffa1ef883b6/go.mod h1:GOYeAPQJ/ok8z7oz1cjfcSlsFpXrmx6VkzQ5RpnyhZM= +github.com/gohugoio/gohugoioTheme v0.0.0-20230109120406-12694c4a9456 h1:RSLItaapVjWkqSdQhumAmJkodFDbWMGNZmkVW/AFx0c= +github.com/gohugoio/gohugoioTheme v0.0.0-20230109120406-12694c4a9456/go.mod h1:GOYeAPQJ/ok8z7oz1cjfcSlsFpXrmx6VkzQ5RpnyhZM= From 3fa1792d24020a7c8a84f7b8043932258101f14b Mon Sep 17 00:00:00 2001 From: Jacob Zhong Date: Tue, 10 Jan 2023 20:29:39 -0500 Subject: [PATCH 14/16] Document the usage of `hardWrap` option for markdown rendering (#1951) --- content/en/getting-started/configuration-markup.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/content/en/getting-started/configuration-markup.md b/content/en/getting-started/configuration-markup.md index 4694bd439..b55bd79c4 100644 --- a/content/en/getting-started/configuration-markup.md +++ b/content/en/getting-started/configuration-markup.md @@ -32,6 +32,9 @@ For details on the extensions, refer to [this section](https://github.com/yuin/g Some settings explained: +hardWrap +: By default, Goldmark ignores newlines within a paragraph. Set to `true` to render newlines as `
` elements. + unsafe : By default, Goldmark does not render raw HTMLs and potentially dangerous links. If you have lots of inline HTML and/or JavaScript, you may need to turn this on. From 27ca65463cb8d6bb3f9bda1b452f372c5af7400d Mon Sep 17 00:00:00 2001 From: Joe Mooring Date: Wed, 11 Jan 2023 13:06:41 -0800 Subject: [PATCH 15/16] Clarify .Page.Param method (#1953) --- content/en/functions/param.md | 59 ++++++++++++++++++++--------------- 1 file changed, 33 insertions(+), 26 deletions(-) diff --git a/content/en/functions/param.md b/content/en/functions/param.md index 5387647d2..4f1764814 100644 --- a/content/en/functions/param.md +++ b/content/en/functions/param.md @@ -1,40 +1,47 @@ --- title: .Param -description: Calls page or site variables into your template. -date: 2017-02-01 -publishdate: 2017-02-01 -lastmod: 2017-04-30 -keywords: ["front matter"] +description: Returns a page parameter, falling back to a site parameter if present. +signature: ['.Param KEY'] categories: [functions] +keywords: ['front matter', 'params'] menu: docs: - parent: "functions" -toc: -signature: [".Param KEY"] -workson: [] -hugoversion: -relatedfuncs: [default] -deprecated: false -draft: false + parent: 'functions' aliases: [] --- -In Hugo, you can declare [site-wide params][sitevars] (i.e. in your [configuration]), as well as params for [individual pages][pagevars]. +The `.Param` method on `.Page` looks for the given `KEY` in page parameters, and returns the corresponding value. If it cannot find the `KEY` in page parameters, it looks for the `KEY` in site parameters. If it cannot find the `KEY` in either location, the `.Param` method returns `nil`. -A common use case is to have a general value for the site and a more specific value for some of the pages (e.g., an image). +Site and theme developers commonly set parameters at the site level, allowing content authors to override those parameters at the page level. -You can use the `.Param` method to call these values into your template. The following will first look for an `image` param in a specific content's [front matter]. If not found, Hugo will look for an `image` param in your site's configuration: +For example, to show a table of contents on every page, but allow authors to hide the table of contents as needed: -``` -$.Param "image" -``` +**Configuration** -{{% note %}} -The `Param` method may not consider empty strings in a content's front matter as "not found." If you are setting preconfigured front matter fields to empty strings using Hugo's archetypes, it may be best to use the [`default` function](/functions/default/) instead of `Param`. See the [related issue on GitHub](https://github.com/gohugoio/hugo/issues/3366). -{{% /note %}} +{{< code-toggle file="config" copy=false >}} +[params] +display_toc = true +{{< /code-toggle >}} +**Content** -[configuration]: /getting-started/configuration/ -[front matter]: /content-management/front-matter/ -[pagevars]: /variables/page/ -[sitevars]: /variables/site/ +{{< code-toggle file="content/about.md" fm=true copy=false >}} +title = 'About' +date = 2023-01-01 +draft = false +display_toc = false +{{< /code-toggle >}} + +**Template** + +{{< code file="layouts/_default/single.html" copy="false" >}} +{{ if .Param "display_toc" }} + {{ .TableOfContents }} +{{ end }} +{{< /code >}} + +The `.Param` method returns the value associated with the given `KEY`, regardless of whether the value is truthy or falsy. If you need to ignore falsy values, use this construct instead: + +{{< code file="layouts/_default/single.html" copy="false" >}} +{{ or .Params.foo site.Params.foo }} +{{< /code >}} From 1214f6ffbf680e853746aaeb6cb097b28c0c556b Mon Sep 17 00:00:00 2001 From: Regis Philibert Date: Sat, 14 Jan 2023 12:21:03 -0500 Subject: [PATCH 16/16] Document cleanDestinationDir configuration setting --- content/en/getting-started/configuration.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/content/en/getting-started/configuration.md b/content/en/getting-started/configuration.md index 39f27453f..3c9b42678 100644 --- a/content/en/getting-started/configuration.md +++ b/content/en/getting-started/configuration.md @@ -173,6 +173,12 @@ Pass down default configuration values (front matter) to pages in the content tr Enable to turn relative URLs into absolute. +### cleanDestinationDir + +**Default value:** false + +When building, removes files from destination not found in static directories. + ### contentDir **Default value:** "content" @@ -231,7 +237,7 @@ Disable automatic live reloading of browser window. **Default value:** false -: Do not convert the url/path to lowercase. +Do not convert the url/path to lowercase. ### enableEmoji