Miscellaneous updates

This commit is contained in:
Joe Mooring authored and GitHub committed 2023-11-04 23:41:53 -07:00
1 parent 723a827fdc
commit 80b2241f9e
133 files changed
+200 -176

No files matched your search

+12 -12
View File
@@ -15,51 +15,51 @@ name = 'Getting started'
weight = 30 weight = 30
identifier = 'getting-started' identifier = 'getting-started'
pageRef = '/getting-started/' pageRef = '/getting-started/'
[[docs]]
name = 'Hugo Modules'
weight = 40
identifier = 'modules'
post = 'break' post = 'break'
pageRef = '/hugo-modules/'
[[docs]] [[docs]]
name = 'Content management' name = 'Content management'
weight = 50 weight = 40
identifier = 'content-management' identifier = 'content-management'
post = 'expanded' post = 'expanded'
pageRef = '/content-management/' pageRef = '/content-management/'
[[docs]] [[docs]]
name = 'Templates' name = 'Templates'
weight = 60 weight = 50
identifier = 'templates' identifier = 'templates'
pageRef = '/templates/' pageRef = '/templates/'
[[docs]] [[docs]]
name = 'Functions' name = 'Functions'
weight = 70 weight = 60
identifier = 'functions' identifier = 'functions'
pageRef = '/functions/' pageRef = '/functions/'
[[docs]] [[docs]]
name = 'Methods' name = 'Methods'
weight = 80 weight = 70
identifier = 'methods' identifier = 'methods'
pageRef = '/methods/' pageRef = '/methods/'
[[docs]] [[docs]]
name = 'Quick reference' name = 'Quick reference'
weight = 90 weight = 80
identifier = 'quick-reference' identifier = 'quick-reference'
pageRef = '/quick-reference/' pageRef = '/quick-reference/'
[[docs]] [[docs]]
name = 'Variables' name = 'Variables'
weight = 95 weight = 85
identifier = 'variables' identifier = 'variables'
pageRef = '/variables/' pageRef = '/variables/'
[[docs]]
name = 'Hugo Modules'
weight = 90
identifier = 'modules'
pageRef = '/hugo-modules/'
[[docs]] [[docs]]
name = 'Hugo Pipes' name = 'Hugo Pipes'
weight = 100 weight = 100
+1
View File
@@ -2,6 +2,7 @@
title: Benefits of static site generators title: Benefits of static site generators
linkTitle: Static site generators linkTitle: Static site generators
description: Improved performance, security and ease of use are just a few of the reasons static site generators are so appealing. description: Improved performance, security and ease of use are just a few of the reasons static site generators are so appealing.
categories: [about]
keywords: [ssg,static,performance,security] keywords: [ssg,static,performance,security]
menu: menu:
docs: docs:
+2
View File
@@ -1,6 +1,8 @@
--- ---
title: Hugo features title: Hugo features
description: Hugo boasts blistering speed, robust content management, and a powerful templating language making it a great fit for all kinds of static websites. description: Hugo boasts blistering speed, robust content management, and a powerful templating language making it a great fit for all kinds of static websites.
categories: [about]
keywords: []
menu: menu:
docs: docs:
parent: about parent: about
+2 -2
View File
@@ -2,15 +2,15 @@
title: Hugo and the General Data Protection Regulation title: Hugo and the General Data Protection Regulation
linkTitle: Hugo and the GDPR linkTitle: Hugo and the GDPR
description: About how to configure your Hugo site to meet the new regulations. description: About how to configure your Hugo site to meet the new regulations.
layout: single categories: [about]
keywords: ["GDPR", "Privacy", "Data Protection"] keywords: ["GDPR", "Privacy", "Data Protection"]
menu: menu:
docs: docs:
parent: about parent: about
weight: 60 weight: 60
weight: 60 weight: 60
aliases: [/privacy/,/gdpr/]
toc: true toc: true
aliases: [/privacy/,/gdpr/]
--- ---
General Data Protection Regulation ([GDPR](https://en.wikipedia.org/wiki/General_Data_Protection_Regulation)) is a regulation in EU law on data protection and privacy for all individuals within the European Union and the European Economic Area. It became enforceable on 25 May 2018. General Data Protection Regulation ([GDPR](https://en.wikipedia.org/wiki/General_Data_Protection_Regulation)) is a regulation in EU law on data protection and privacy for all individuals within the European Union and the European Economic Area. It became enforceable on 25 May 2018.
+2 -2
View File
@@ -1,8 +1,8 @@
--- ---
title: License title: License
description: Hugo is released under the Apache 2.0 license. description: Hugo is released under the Apache 2.0 license.
categories: ["about hugo"] categories: [about]
keywords: ["license","apache"] keywords: [license,apache]
menu: menu:
docs: docs:
parent: about parent: about
+3 -3
View File
@@ -1,15 +1,15 @@
--- ---
title: Hugo's security model title: Hugo's security model
description: A summary of Hugo's security model. description: A summary of Hugo's security model.
layout: single categories: [about]
keywords: ["Security", "Privacy"] keywords: [security,privacy]
menu: menu:
docs: docs:
parent: about parent: about
weight: 50 weight: 50
weight: 50 weight: 50
aliases: [/security/]
toc: true toc: true
aliases: [/security/]
--- ---
## Runtime security ## Runtime security
+3 -2
View File
@@ -1,14 +1,15 @@
--- ---
title: What is Hugo title: What is Hugo
description: Hugo is a fast and modern static site generator written in Go, and designed to make website creation fun again. description: Hugo is a fast and modern static site generator written in Go, and designed to make website creation fun again.
layout: single categories: [about]
keywords: []
menu: menu:
docs: docs:
parent: about parent: about
weight: 20 weight: 20
weight: 20 weight: 20
aliases: [/overview/introduction/,/about/why-i-built-hugo/]
toc: true toc: true
aliases: [/overview/introduction/,/about/why-i-built-hugo/]
--- ---
Hugo is a general-purpose website framework. Technically speaking, Hugo is a [static site generator]. Unlike systems that dynamically build a page with each visitor request, Hugo builds pages when you create or update your content. Since websites are viewed far more often than they are edited, Hugo is designed to provide an optimal viewing experience for your website's end users and an ideal writing experience for website authors. Hugo is a general-purpose website framework. Technically speaking, Hugo is a [static site generator]. Unlike systems that dynamically build a page with each visitor request, Hugo builds pages when you create or update your content. Since websites are viewed far more often than they are edited, Hugo is designed to provide an optimal viewing experience for your website's end users and an ideal writing experience for website authors.
+2 -2
View File
@@ -2,13 +2,13 @@
title: Content management title: Content management
linkTitle: Overview linkTitle: Overview
description: Hugo makes managing large static sites easy with support for archetypes, content types, menus, cross references, summaries, and more. description: Hugo makes managing large static sites easy with support for archetypes, content types, menus, cross references, summaries, and more.
categories: []
keywords: []
menu: menu:
docs: docs:
identifier: content-management-overview identifier: content-management-overview
parent: content-management parent: content-management
weight: 10 weight: 10
keywords: [source, organization]
categories: [content management]
weight: 10 weight: 10
aliases: [/content/,/content/organization] aliases: [/content/,/content/organization]
--- ---
+2 -2
View File
@@ -1,15 +1,15 @@
--- ---
title: Archetypes title: Archetypes
description: An archetype is a template for new content. description: An archetype is a template for new content.
keywords: [archetypes,generators,metadata,front matter]
categories: [content management] categories: [content management]
keywords: [archetypes,generators,metadata,front matter]
menu: menu:
docs: docs:
parent: content-management parent: content-management
weight: 140 weight: 140
quicklinks: quicklinks:
toc: true
weight: 140 weight: 140
toc: true
aliases: [/content/archetypes/] aliases: [/content/archetypes/]
--- ---
@@ -1,14 +1,14 @@
--- ---
title: Build options title: Build options
description: Build options help define how Hugo must treat a given page when building the site. description: Build options help define how Hugo must treat a given page when building the site.
categories: [content management,fundamentals]
keywords: [build,content,front matter, page resources] keywords: [build,content,front matter, page resources]
categories: [fundamentals,content management]
menu: menu:
docs: docs:
parent: content-management parent: content-management
weight: 70 weight: 70
toc: true
weight: 70 weight: 70
toc: true
aliases: [/content/build-options/] aliases: [/content/build-options/]
--- ---
+2 -2
View File
@@ -1,14 +1,14 @@
--- ---
title: Comments title: Comments
description: Hugo ships with an internal Disqus template, but this isn't the only commenting system that will work with your new Hugo website. description: Hugo ships with an internal Disqus template, but this isn't the only commenting system that will work with your new Hugo website.
categories: [content management]
keywords: [sections,content,organization] keywords: [sections,content,organization]
categories: [project organization]
menu: menu:
docs: docs:
parent: content-management parent: content-management
weight: 220 weight: 220
toc: true
weight: 220 weight: 220
toc: true
aliases: [/extras/comments/] aliases: [/extras/comments/]
--- ---
@@ -2,13 +2,13 @@
title: Links and cross references title: Links and cross references
description: Shortcodes for creating links to documents. description: Shortcodes for creating links to documents.
categories: [content management] categories: [content management]
keywords: ["cross references","references", "anchors", "urls"] keywords: [cross references,references,anchors,urls]
menu: menu:
docs: docs:
parent: content-management parent: content-management
weight: 170 weight: 170
toc: true
weight: 170 weight: 170
toc: true
aliases: [/extras/crossreferences/] aliases: [/extras/crossreferences/]
--- ---
+1 -1
View File
@@ -7,8 +7,8 @@ menu:
docs: docs:
parent: content-management parent: content-management
weight: 50 weight: 50
toc: true
weight: 50 weight: 50
toc: true
--- ---
{{< new-in "0.93.0" >}} {{< new-in "0.93.0" >}}
+1 -1
View File
@@ -7,8 +7,8 @@ menu:
docs: docs:
parent: content-management parent: content-management
weight: 40 weight: 40
toc: true
weight: 40 weight: 40
toc: true
aliases: [/content/markdown-extras/,/content/supported-formats/,/doc/supported-formats/] aliases: [/content/markdown-extras/,/content/supported-formats/,/doc/supported-formats/]
--- ---
@@ -2,13 +2,13 @@
title: Front matter title: Front matter
description: Hugo allows you to add front matter in yaml, toml, or json to your content files. description: Hugo allows you to add front matter in yaml, toml, or json to your content files.
categories: [content management] categories: [content management]
keywords: ["front matter", "yaml", "toml", "json", "metadata", "archetypes"] keywords: [front matter,yaml,toml,json,metadata,archetypes]
menu: menu:
docs: docs:
parent: content-management parent: content-management
weight: 60 weight: 60
toc: true
weight: 60 weight: 60
toc: true
aliases: [/content/front-matter/] aliases: [/content/front-matter/]
--- ---
@@ -1,8 +1,8 @@
--- ---
title: Image processing title: Image processing
description: Resize, crop, rotate, filter, and convert images. description: Resize, crop, rotate, filter, and convert images.
categories: [fundamentals,content management] categories: [content management,fundamentals]
keywords: [resources, images] keywords: [resources,images]
menu: menu:
docs: docs:
parent: content-management parent: content-management
+1 -1
View File
@@ -7,8 +7,8 @@ menu:
docs: docs:
parent: content-management parent: content-management
weight: 190 weight: 190
toc: true
weight: 190 weight: 190
toc: true
aliases: [/extras/menus/] aliases: [/extras/menus/]
--- ---
@@ -3,13 +3,13 @@ title: Multilingual mode
linkTitle: Multilingual linkTitle: Multilingual
description: Hugo supports the creation of websites with multiple languages side by side. description: Hugo supports the creation of websites with multiple languages side by side.
categories: [content management] categories: [content management]
keywords: [multilingual,i18n, internationalization] keywords: [multilingual,i18n,internationalization]
menu: menu:
docs: docs:
parent: content-management parent: content-management
weight: 230 weight: 230
toc: true
weight: 230 weight: 230
toc: true
aliases: [/content/multilingual/,/tutorials/create-a-multilingual-site/] aliases: [/content/multilingual/,/tutorials/create-a-multilingual-site/]
--- ---
@@ -2,14 +2,14 @@
title: Content organization title: Content organization
linkTitle: Organization linkTitle: Organization
description: Hugo assumes that the same structure that works to organize your source content is used to organize the rendered site. description: Hugo assumes that the same structure that works to organize your source content is used to organize the rendered site.
categories: [fundamentals,content management] categories: [content management,fundamentals]
keywords: [sections,content,organization,bundle,resources] keywords: [sections,content,organization,bundle,resources]
menu: menu:
docs: docs:
parent: content-management parent: content-management
weight: 20 weight: 20
toc: true
weight: 20 weight: 20
toc: true
aliases: [/content/sections/] aliases: [/content/sections/]
--- ---
@@ -1,14 +1,14 @@
--- ---
title: Page bundles title: Page bundles
description: Content organization using Page Bundles description: Content organization using Page Bundles
keywords: [page, bundle, leaf, branch]
categories: [content management] categories: [content management]
keywords: [page,bundle,leaf,branch]
menu : menu :
docs: docs:
parent: content-management parent: content-management
weight: 30 weight: 30
toc: true
weight: 30 weight: 30
toc: true
--- ---
Page Bundles are a way to group [Page Resources](/content-management/page-resources/). Page Bundles are a way to group [Page Resources](/content-management/page-resources/).
@@ -7,8 +7,8 @@ menu:
docs: docs:
parent: content-management parent: content-management
weight: 80 weight: 80
toc: true
weight: 80 weight: 80
toc: true
--- ---
Page resources are only accessible from [page bundles](/content-management/page-bundles), those directories with `index.md` or Page resources are only accessible from [page bundles](/content-management/page-bundles), those directories with `index.md` or
`_index.md` files at their root. Page resources are only available to the `_index.md` files at their root. Page resources are only available to the
+1 -1
View File
@@ -7,8 +7,8 @@ menu:
docs: docs:
parent: content-management parent: content-management
weight: 110 weight: 110
toc: true
weight: 110 weight: 110
toc: true
aliases: [/content/related/,/related/] aliases: [/content/related/,/related/]
--- ---
+1 -1
View File
@@ -8,8 +8,8 @@ menu:
docs: docs:
parent: content-management parent: content-management
weight: 120 weight: 120
toc: true
weight: 120 weight: 120
toc: true
aliases: [/content/sections/] aliases: [/content/sections/]
--- ---
+1 -1
View File
@@ -7,8 +7,8 @@ menu:
docs: docs:
parent: content-management parent: content-management
weight: 100 weight: 100
toc: true
weight: 100 weight: 100
toc: true
aliases: [/extras/shortcodes/] aliases: [/extras/shortcodes/]
testparam: "Hugo Rocks!" testparam: "Hugo Rocks!"
--- ---
@@ -7,8 +7,8 @@ menu:
docs: docs:
parent: content-management parent: content-management
weight: 200 weight: 200
toc: true
weight: 200 weight: 200
toc: true
aliases: [/static-files] aliases: [/static-files]
--- ---
+1 -1
View File
@@ -8,8 +8,8 @@ menu:
docs: docs:
parent: content-management parent: content-management
weight: 160 weight: 160
toc: true
weight: 160 weight: 160
toc: true
aliases: [/content/summaries/,/content-management/content-summaries/] aliases: [/content/summaries/,/content-management/content-summaries/]
--- ---
@@ -1,14 +1,14 @@
--- ---
title: Syntax highlighting title: Syntax highlighting
description: Hugo comes with really fast syntax highlighting from Chroma. description: Hugo comes with really fast syntax highlighting from Chroma.
keywords: [highlighting,chroma,code blocks,syntax]
categories: [content management] categories: [content management]
keywords: [highlighting,chroma,code blocks,syntax]
menu: menu:
docs: docs:
parent: content-management parent: content-management
weight: 240 weight: 240
toc: true
weight: 240 weight: 240
toc: true
aliases: [/extras/highlighting/,/extras/highlight/,/tools/syntax-highlighting/] aliases: [/extras/highlighting/,/extras/highlight/,/tools/syntax-highlighting/]
--- ---
+2 -2
View File
@@ -1,14 +1,14 @@
--- ---
title: Taxonomies title: Taxonomies
description: Hugo includes support for user-defined taxonomies. description: Hugo includes support for user-defined taxonomies.
keywords: [taxonomies,metadata,front matter,terms]
categories: [content management] categories: [content management]
keywords: [taxonomies,metadata,front matter,terms]
menu: menu:
docs: docs:
parent: content-management parent: content-management
weight: 150 weight: 150
toc: true
weight: 150 weight: 150
toc: true
aliases: [/taxonomies/overview/,/taxonomies/usage/,/indexes/overview/,/doc/indexes/,/extras/indexes] aliases: [/taxonomies/overview/,/taxonomies/usage/,/indexes/overview/,/doc/indexes/,/extras/indexes]
--- ---
+1 -1
View File
@@ -7,8 +7,8 @@ menu:
docs: docs:
parent: content-management parent: content-management
weight: 210 weight: 210
toc: true
weight: 210 weight: 210
toc: true
aliases: [/extras/toc/] aliases: [/extras/toc/]
--- ---
+2 -2
View File
@@ -2,13 +2,13 @@
title: Content types title: Content types
description: Hugo is built around content organized in sections. description: Hugo is built around content organized in sections.
categories: [content management] categories: [content management]
keywords: [lists, sections, content types, types, organization] keywords: [lists,sections,content types,types,organization]
menu: menu:
docs: docs:
parent: content-management parent: content-management
weight: 130 weight: 130
toc: true
weight: 130 weight: 130
toc: true
aliases: [/content/types] aliases: [/content/types]
--- ---
+1 -1
View File
@@ -7,8 +7,8 @@ menu:
docs: docs:
parent: content-management parent: content-management
weight: 180 weight: 180
toc: true
weight: 180 weight: 180
toc: true
aliases: [/extras/permalinks/,/extras/aliases/,/extras/urls/,/doc/redirects/,/doc/alias/,/doc/aliases/] aliases: [/extras/permalinks/,/extras/aliases/,/extras/urls/,/doc/redirects/,/doc/alias/,/doc/aliases/]
--- ---
+1 -1
View File
@@ -2,7 +2,7 @@
title: Contribute to the Hugo project title: Contribute to the Hugo project
linkTitle: Overview linkTitle: Overview
description: Contribute to Hugo development and documentation. description: Contribute to Hugo development and documentation.
categories: [contribute] categories: []
keywords: [] keywords: []
menu: menu:
docs: docs:
+1 -1
View File
@@ -9,8 +9,8 @@ menu:
parent: contribute parent: contribute
weight: 40 weight: 40
weight: 40 weight: 40
aliases: [/contribute/theme/]
toc: true toc: true
aliases: [/contribute/theme/]
--- ---
A collection of all themes created by the Hugo community, including screenshots and demos, can be found at [themes.gohugo.io]. Every theme in this list will automatically be added to the theme site. A collection of all themes created by the Hugo community, including screenshots and demos, can be found at [themes.gohugo.io]. Every theme in this list will automatically be added to the theme site.
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: collections.Group title: collections.Group
description: Groups a list of pages. description: Groups the given page collection by the given key.
categories: [] categories: []
keywords: [] keywords: []
action: action:
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: collections.Slice title: collections.Slice
description: Creates a slice (array) of all passed arguments. description: Creates a slice of all passed arguments.
categories: [] categories: []
keywords: [] keywords: []
action: action:
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: encoding.Jsonify title: encoding.Jsonify
description: Encodes a given object to JSON. description: Encodes the given object to JSON.
categories: [] categories: []
keywords: [] keywords: []
action: action:
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: site title: site
description: Provides global access to the Site object. description: Provides global access to the current Site object.
categories: [] categories: []
keywords: [] keywords: []
action: action:
+1 -1
View File
@@ -21,7 +21,7 @@ toc: true
```go-html-template ```go-html-template
{{ $s := slice "foo" "bar" "baz" }} {{ $s := slice "foo" "bar" "baz" }}
{{ range $var }} {{ range $var }}
{{ . }} → foo "bar" "baz" {{ . }} → foo bar baz
{{ end }} {{ end }}
``` ```
+6 -1
View File
@@ -25,7 +25,12 @@ See [image processing] for an overview of Hugo's image pipeline.
Supported image formats include GIF, JPEG, PNG, TIFF, and WebP. Supported image formats include GIF, JPEG, PNG, TIFF, and WebP.
{{% note %}} {{% note %}}
This is a legacy function, superseded by the `.Width` and `.Height` methods for global, page, and remote resources. See the [image processing] section for details. This is a legacy function, superseded by the [`Width`] and [`Height`] methods for [global], [page], and [remote] resources. See the [image processing] section for details.
[`Width`]: /methods/resource/width
[`Height`]: /methods/resource/height
[global]: /getting-started/glossary/#global-resource
[image processing]: /content-management/image-processing [image processing]: /content-management/image-processing
[page]: /getting-started/glossary/#page-resource
[remote]: /getting-started/glossary/#remote-resource
{{% /note %}} {{% /note %}}
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: reflect.IsMap title: reflect.IsMap
description: Reports whether the value is a map. description: Reports whether the given value is a map.
categories: [] categories: []
keywords: [] keywords: []
action: action:
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: reflect.IsSlice title: reflect.IsSlice
description: Reports whether the value is a slice. description: Reports whether the given value is a slice.
categories: [] categories: []
keywords: [] keywords: []
action: action:
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: safe.CSS title: safe.CSS
description: Declares the provided string as safe CSS string. description: Declares the given string as safe CSS string.
categories: [] categories: []
keywords: [] keywords: []
action: action:
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: safe.HTML title: safe.HTML
description: Declares a provided string as a safeHTML string. description: Declares the given string as a safeHTML string.
categories: [] categories: []
keywords: [] keywords: []
action: action:
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: safe.HTMLAttr title: safe.HTMLAttr
description: Declares the provided string as a safe HTML attribute. description: Declares the given key/value pair as a safe HTML attribute.
categories: [] categories: []
keywords: [] keywords: []
action: action:
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: safe.JS title: safe.JS
description: Declares the provided string as a safe JavaScript string. description: Declares the given string as a safe JavaScript expression.
categories: [] categories: []
keywords: [] keywords: []
action: action:
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: safe.JSStr title: safe.JSStr
description: Declares the provided string as a known safe JavaScript string. description: Declares the given string as a safe JavaScript string.
categories: [] categories: []
keywords: [] keywords: []
action: action:
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: safe.URL title: safe.URL
description: Declares the provided string as a safe URL or URL substring. description: Declares the given string as a safe URL or URL substring.
categories: [] categories: []
keywords: [] keywords: []
action: action:
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: strings.FirstUpper title: strings.FirstUpper
description: Capitalizes the first character of a given string. description: Returns the given string, capitalizing the first character.
categories: [] categories: []
keywords: [] keywords: []
action: action:
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: strings.ToLower title: strings.ToLower
description: Converts all characters in the given string to lowercase. description: Returns the given string, converting all characters to lowercase.
categories: [] categories: []
keywords: [] keywords: []
action: action:
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: strings.ToUpper title: strings.ToUpper
description: Converts all characters in the given string to uppercase. description: Returns the given string, converting all characters to uppercase.
categories: [] categories: []
keywords: [] keywords: []
action: action:
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: templates.Exists title: templates.Exists
description: Reports whether a template file exists under the given path relative to the `layouts` directory. description: Reports whether a template file exists under the given path relative to the layouts directory.
categories: [] categories: []
keywords: [] keywords: []
action: action:
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: time.AsTime title: time.AsTime
description: Converts a string representation of a date/time to a time.Time value. description: Returns the given string representation of a date/time value as a time.Time value.
categories: [] categories: []
keywords: [] keywords: []
action: action:
+2 -2
View File
@@ -2,8 +2,8 @@
title: Getting started title: Getting started
linkTitle: Overview linkTitle: Overview
description: Quick start and guides for installing Hugo on your preferred operating system. description: Quick start and guides for installing Hugo on your preferred operating system.
categories: [getting started] categories: []
keywords: [usage,docs] keywords: []
menu: menu:
docs: docs:
identifier: getting-started-overview identifier: getting-started-overview
@@ -1,7 +1,7 @@
--- ---
title: Configure markup title: Configure markup
description: Configure rendering of markup to HTML. description: Configure rendering of markup to HTML.
categories: [fundamentals, getting started] categories: [getting started,fundamentals]
keywords: [configuration,highlighting] keywords: [configuration,highlighting]
menu: menu:
docs: docs:
+2 -2
View File
@@ -2,15 +2,15 @@
title: Configure Hugo title: Configure Hugo
linkTitle: Configuration linkTitle: Configuration
description: How to configure your Hugo site. description: How to configure your Hugo site.
categories: [fundamentals,getting started] categories: [getting started,fundamentals]
keywords: [configuration,toml,yaml,json] keywords: [configuration,toml,yaml,json]
menu: menu:
docs: docs:
parent: getting-started parent: getting-started
weight: 40 weight: 40
weight: 40 weight: 40
aliases: [/overview/source-directory/,/overview/configuration/]
toc: true toc: true
aliases: [/overview/source-directory/,/overview/configuration/]
--- ---
## Configuration file ## Configuration file
@@ -1,15 +1,15 @@
--- ---
title: Directory structure title: Directory structure
description: Each Hugo project is a directory, with subdirectories that contribute to the content, structure, behavior, and presentation of your site. description: Each Hugo project is a directory, with subdirectories that contribute to the content, structure, behavior, and presentation of your site.
categories: [fundamentals,getting started] categories: [getting started,fundamentals]
keywords: [source, organization, directories] keywords: [source, organization, directories]
menu: menu:
docs: docs:
parent: getting-started parent: getting-started
weight: 30 weight: 30
weight: 30 weight: 30
aliases: [/overview/source-directory/]
toc: true toc: true
aliases: [/overview/source-directory/]
--- ---
## Site skeleton ## Site skeleton
@@ -1,6 +1,7 @@
--- ---
title: External learning resources title: External learning resources
description: A list of tutorials and books on Hugo. description: A list of tutorials and books on Hugo.
categories: [getting started]
keywords: [books, tutorials, learning, usage] keywords: [books, tutorials, learning, usage]
menu: menu:
docs: docs:
+1
View File
@@ -1,6 +1,7 @@
--- ---
title: Glossary of terms title: Glossary of terms
description: Terms commonly used throughout the documentation. description: Terms commonly used throughout the documentation.
categories: [getting started]
keywords: [glossary] keywords: [glossary]
menu: menu:
docs: docs:
+1 -1
View File
@@ -8,8 +8,8 @@ menu:
parent: getting-started parent: getting-started
weight: 30 weight: 30
weight: 30 weight: 30
aliases: [/overview/usage/,/extras/livereload/,/doc/usage/,/usage/]
toc: true toc: true
aliases: [/overview/usage/,/extras/livereload/,/doc/usage/,/usage/]
--- ---
## Test your installation ## Test your installation
+1 -1
View File
@@ -2,7 +2,7 @@
title: Hosting and deployment title: Hosting and deployment
linkTitle: Overview linkTitle: Overview
description: Site builds, automated deployments, and popular hosting solutions. description: Site builds, automated deployments, and popular hosting solutions.
categories: [hosting and deployment] categories: []
keywords: [] keywords: []
menu: menu:
docs: docs:
@@ -2,12 +2,12 @@
title: Deploy with Rclone title: Deploy with Rclone
description: If you have access to your web host with SFTP/FTP/SSH/HTTP(DAV), you can use rclone to incrementally deploy your entire Hugo website. description: If you have access to your web host with SFTP/FTP/SSH/HTTP(DAV), you can use rclone to incrementally deploy your entire Hugo website.
categories: [hosting and deployment] categories: [hosting and deployment]
keywords: [rclone,sftp,deployment] keywords: [deployment,rclone,sftp]
menu: menu:
docs: docs:
parent: hosting-and-deployment parent: hosting-and-deployment
aliases: [/tutorials/deployment-with-rclone/]
toc: true toc: true
aliases: [/tutorials/deployment-with-rclone/]
--- ---
## Assumptions ## Assumptions
@@ -2,12 +2,12 @@
title: Deploy with Rsync title: Deploy with Rsync
description: If you have access to your web host with SSH, you can use a simple rsync one-liner to incrementally deploy your entire Hugo website. description: If you have access to your web host with SSH, you can use a simple rsync one-liner to incrementally deploy your entire Hugo website.
categories: [hosting and deployment] categories: [hosting and deployment]
keywords: [rsync,deployment] keywords: [deployment,rsync]
menu: menu:
docs: docs:
parent: hosting-and-deployment parent: hosting-and-deployment
aliases: [/tutorials/deployment-with-rsync/]
toc: true toc: true
aliases: [/tutorials/deployment-with-rsync/]
--- ---
## Assumptions ## Assumptions
@@ -2,7 +2,7 @@
title: Host on 21YunBox title: Host on 21YunBox
description: Host your Hugo site with 21YunBox's blazing fast Chinese CDN, fully-managed SSL and auto deploys from Gitee. description: Host your Hugo site with 21YunBox's blazing fast Chinese CDN, fully-managed SSL and auto deploys from Gitee.
categories: [hosting and deployment] categories: [hosting and deployment]
keywords: [21yunbox,hosting,deployment] keywords: [hosting,21yunbox]
menu: menu:
docs: docs:
parent: hosting-and-deployment parent: hosting-and-deployment
@@ -2,7 +2,7 @@
title: Host on AWS Amplify title: Host on AWS Amplify
description: Develop and deploy a cloud-powered web app with AWS Amplify. description: Develop and deploy a cloud-powered web app with AWS Amplify.
categories: [hosting and deployment] categories: [hosting and deployment]
keywords: [amplify,hosting,deployment] keywords: [hosting,amplify]
menu: menu:
docs: docs:
parent: hosting-and-deployment parent: hosting-and-deployment
@@ -2,7 +2,7 @@
title: Host on Azure Static Web Apps title: Host on Azure Static Web Apps
description: Publish a Hugo site to Azure Static Web Apps. description: Publish a Hugo site to Azure Static Web Apps.
categories: [hosting and deployment] categories: [hosting and deployment]
keywords: [hosting,Azure Static Web Apps] keywords: [hosting,azure]
menu: menu:
docs: docs:
parent: hosting-and-deployment parent: hosting-and-deployment
@@ -2,6 +2,7 @@
title: Host on Cloudflare Pages title: Host on Cloudflare Pages
description: Cloudflare Pages can host your Hugo site with CDN, continuous deployment, 1-click HTTPS, an admin GUI, and its own environment variables. description: Cloudflare Pages can host your Hugo site with CDN, continuous deployment, 1-click HTTPS, an admin GUI, and its own environment variables.
categories: [hosting and deployment] categories: [hosting and deployment]
keywords: [hosting,cloudflare]
menu: menu:
docs: docs:
parent: hosting-and-deployment parent: hosting-and-deployment
@@ -2,7 +2,7 @@
title: Host on GitHub Pages title: Host on GitHub Pages
description: Deploy Hugo as a GitHub Pages project or personal/organizational site and automate the whole process with GitHub Actions description: Deploy Hugo as a GitHub Pages project or personal/organizational site and automate the whole process with GitHub Actions
categories: [hosting and deployment] categories: [hosting and deployment]
keywords: [github,git,deployment,hosting] keywords: [hosting,github]
menu: menu:
docs: docs:
parent: hosting-and-deployment parent: hosting-and-deployment
@@ -2,7 +2,7 @@
title: Host on GitLab Pages title: Host on GitLab Pages
description: GitLab makes it easy to build, deploy, and host your Hugo website via their free GitLab Pages service, which provides native support for Hugo. description: GitLab makes it easy to build, deploy, and host your Hugo website via their free GitLab Pages service, which provides native support for Hugo.
categories: [hosting and deployment] categories: [hosting and deployment]
keywords: [hosting,deployment,git,gitlab] keywords: [hosting,gitlab]
menu: menu:
docs: docs:
parent: hosting-and-deployment parent: hosting-and-deployment
@@ -2,7 +2,7 @@
title: Host on KeyCDN title: Host on KeyCDN
description: "Accelerate your Hugo site globally with a KeyCDN integration. This tutorial shows you how to set up your static site as a GitLab page behind a KeyCDN pull zone." description: "Accelerate your Hugo site globally with a KeyCDN integration. This tutorial shows you how to set up your static site as a GitLab page behind a KeyCDN pull zone."
categories: [hosting and deployment] categories: [hosting and deployment]
keywords: [keycdn,hosting,deployment,cdn] keywords: [hosting,keycdn]
menu: menu:
docs: docs:
parent: hosting-and-deployment parent: hosting-and-deployment
@@ -2,7 +2,7 @@
title: Host on Netlify title: Host on Netlify
description: Netlify can host your Hugo site with CDN, continuous deployment, 1-click HTTPS, an admin GUI, and its own CLI. description: Netlify can host your Hugo site with CDN, continuous deployment, 1-click HTTPS, an admin GUI, and its own CLI.
categories: [hosting and deployment] categories: [hosting and deployment]
keywords: [netlify,hosting,deployment] keywords: [hosting,netlify]
menu: menu:
docs: docs:
parent: hosting-and-deployment parent: hosting-and-deployment
@@ -2,7 +2,7 @@
title: Host on Render title: Host on Render
description: Host your Hugo site for free with Render's global CDN, fully-managed SSL and auto deploys from GitHub. description: Host your Hugo site for free with Render's global CDN, fully-managed SSL and auto deploys from GitHub.
categories: [hosting and deployment] categories: [hosting and deployment]
keywords: [hosting,deployment] keywords: [hosting]
menu: menu:
docs: docs:
parent: hosting-and-deployment parent: hosting-and-deployment
@@ -2,7 +2,7 @@
title: Hugo Deploy title: Hugo Deploy
description: You can upload your site to GCS, S3, or Azure using the Hugo CLI. description: You can upload your site to GCS, S3, or Azure using the Hugo CLI.
categories: [hosting and deployment] categories: [hosting and deployment]
keywords: [s3,gcs,azure,hosting,deployment] keywords: [deployment,s3,gcs,azure]
menu: menu:
docs: docs:
parent: hosting-and-deployment parent: hosting-and-deployment
+3 -3
View File
@@ -2,16 +2,16 @@
title: Hugo Modules title: Hugo Modules
linkTitle: Overview linkTitle: Overview
description: How to use Hugo Modules. description: How to use Hugo Modules.
categories: []
keywords: []
menu: menu:
docs: docs:
identifier: hugo-modules-overview identifier: hugo-modules-overview
parent: modules parent: modules
weight: 10 weight: 10
weight: 10 weight: 10
categories: [hugo modules]
keywords: [themes,modules]
aliases: [/themes/overview/,/themes/]
toc: true toc: true
aliases: [/themes/overview/,/themes/]
--- ---
**Hugo Modules** are the core building blocks in Hugo. A _module_ can be your main project or a smaller module providing one or more of the 7 component types defined in Hugo: **static**, **content**, **layouts**, **data**, **assets**, **i18n**, and **archetypes**. **Hugo Modules** are the core building blocks in Hugo. A _module_ can be your main project or a smaller module providing one or more of the 7 component types defined in Hugo: **static**, **content**, **layouts**, **data**, **assets**, **i18n**, and **archetypes**.
+1 -1
View File
@@ -2,7 +2,7 @@
title: Configure Hugo modules title: Configure Hugo modules
description: This page describes the configuration options for a module. description: This page describes the configuration options for a module.
categories: [hugo modules] categories: [hugo modules]
keywords: [themes, source, organization, directories] keywords: [modules,themes]
menu: menu:
docs: docs:
parent: modules parent: modules
+1 -1
View File
@@ -2,7 +2,7 @@
title: Theme components title: Theme components
description: Hugo provides advanced theming support with Theme Components. description: Hugo provides advanced theming support with Theme Components.
categories: [hugo modules] categories: [hugo modules]
keywords: [themes, theme, source, organization, directories] keywords: [modules,themes]
menu: menu:
docs: docs:
parent: modules parent: modules
+1 -1
View File
@@ -2,7 +2,7 @@
title: Use Hugo Modules title: Use Hugo Modules
description: How to use Hugo Modules to build and manage your site. description: How to use Hugo Modules to build and manage your site.
categories: [hugo modules] categories: [hugo modules]
keywords: [install, themes, source, organization, directories,usage,modules] keywords: [modules,themes]
menu: menu:
docs: docs:
parent: modules parent: modules
+1 -1
View File
@@ -1,7 +1,7 @@
--- ---
title: Hugo Pipes title: Hugo Pipes
linkTitle: Overview linkTitle: Overview
categories: [asset management] categories: []
keywords: [] keywords: []
menu: menu:
docs: docs:
+1 -1
View File
@@ -8,7 +8,7 @@ menu:
parent: hugo-pipes parent: hugo-pipes
weight: 70 weight: 70
weight: 70 weight: 70
function: action:
aliases: [babel] aliases: [babel]
returnType: resource.Resource returnType: resource.Resource
signatures: ['resources.Babel [OPTIONS] RESOURCE'] signatures: ['resources.Babel [OPTIONS] RESOURCE']
+1 -1
View File
@@ -9,7 +9,7 @@ menu:
parent: hugo-pipes parent: hugo-pipes
weight: 90 weight: 90
weight: 90 weight: 90
function: action:
aliases: [] aliases: []
returnType: resource.Resource returnType: resource.Resource
signatures: ['resources.Concat TARGETPATH [RESOURCE...]'] signatures: ['resources.Concat TARGETPATH [RESOURCE...]']
+2 -2
View File
@@ -9,10 +9,10 @@ menu:
parent: hugo-pipes parent: hugo-pipes
weight: 100 weight: 100
weight: 100 weight: 100
function: action:
aliases: [fingerprint] aliases: [fingerprint]
returnType: resource.Resource returnType: resource.Resource
signatures: ['resources.Fingerprint RESOURCE [ALGORITHM]'] signatures: ['resources.Fingerprint [ALGORITHM] RESOURCE']
--- ---
## Usage ## Usage
+1 -1
View File
@@ -9,7 +9,7 @@ menu:
parent: hugo-pipes parent: hugo-pipes
weight: 60 weight: 60
weight: 60 weight: 60
function: action:
aliases: [] aliases: []
returnType: resource.Resource returnType: resource.Resource
signatures: ['js.Build [OPTIONS] RESOURCE'] signatures: ['js.Build [OPTIONS] RESOURCE']
+1 -1
View File
@@ -9,7 +9,7 @@ menu:
parent: hugo-pipes parent: hugo-pipes
weight: 80 weight: 80
weight: 80 weight: 80
function: action:
aliases: [minify] aliases: [minify]
returnType: resource.Resource returnType: resource.Resource
signatures: [resources.Minify RESOURCE] signatures: [resources.Minify RESOURCE]
+2 -2
View File
@@ -7,9 +7,9 @@ menu:
docs: docs:
parent: hugo-pipes parent: hugo-pipes
weight: 40 weight: 40
toc: true
weight: 40 weight: 40
function: toc: true
action:
aliases: [postCSS] aliases: [postCSS]
returnType: resource.Resource returnType: resource.Resource
signatures: ['resources.PostCSS [OPTIONS] RESOURCE'] signatures: ['resources.PostCSS [OPTIONS] RESOURCE']
+1 -1
View File
@@ -8,7 +8,7 @@ menu:
parent: hugo-pipes parent: hugo-pipes
weight: 50 weight: 50
weight: 50 weight: 50
function: action:
aliases: [] aliases: []
returnType: postpub.PostPublishedResource returnType: postpub.PostPublishedResource
signatures: [resources.PostProcess RESOURCE] signatures: [resources.PostProcess RESOURCE]
@@ -9,7 +9,7 @@ menu:
parent: hugo-pipes parent: hugo-pipes
weight: 110 weight: 110
weight: 110 weight: 110
function: action:
aliases: [] aliases: []
returnType: resource.Resource returnType: resource.Resource
signatures: [resources.FromString TARGETPATH STRING] signatures: [resources.FromString TARGETPATH STRING]
@@ -9,10 +9,10 @@ menu:
parent: hugo-pipes parent: hugo-pipes
weight: 120 weight: 120
weight: 120 weight: 120
function: action:
aliases: [] aliases: []
returnType: resource.Resource returnType: resource.Resource
signatures: [resources.ExecuteAsTemplate TARGETPATH CONTEXT RESOURCE'] signatures: [resources.ExecuteAsTemplate TARGETPATH CONTEXT RESOURCE]
--- ---
## Usage ## Usage
@@ -10,8 +10,9 @@ menu:
returnType: resource.Resource returnType: resource.Resource
weight: 30 weight: 30
weight: 30 weight: 30
function: action:
aliases: [toCSS] aliases: [toCSS]
returnType: resource.Resource
signatures: ['resources.ToCSS [OPTIONS] RESOURCE'] signatures: ['resources.ToCSS [OPTIONS] RESOURCE']
toc: true toc: true
aliases: [/hugo-pipes/transform-to-css/] aliases: [/hugo-pipes/transform-to-css/]
+2 -2
View File
@@ -3,8 +3,8 @@ title: Installation
linkTitle: Overview linkTitle: Overview
description: Install Hugo on macOS, Linux, Windows, BSD, and on any machine that can run the Go compiler tool chain. description: Install Hugo on macOS, Linux, Windows, BSD, and on any machine that can run the Go compiler tool chain.
aliases: [/getting-started/installing/] aliases: [/getting-started/installing/]
categories: [installation] categories: []
keywords: [installation] keywords: []
menu: menu:
docs: docs:
identifier: installation-overview identifier: installation-overview
+2 -1
View File
@@ -2,12 +2,13 @@
title: BSD title: BSD
description: Install Hugo on BSD derivatives. description: Install Hugo on BSD derivatives.
categories: [installation] categories: [installation]
keywords: []
menu: menu:
docs: docs:
parent: installation parent: installation
weight: 50 weight: 50
toc: true
weight: 50 weight: 50
toc: true
--- ---
{{% include "installation/_common/01-editions.md" %}} {{% include "installation/_common/01-editions.md" %}}
+2 -1
View File
@@ -2,12 +2,13 @@
title: Linux title: Linux
description: Install Hugo on Linux. description: Install Hugo on Linux.
categories: [installation] categories: [installation]
keywords: []
menu: menu:
docs: docs:
parent: installation parent: installation
weight: 30 weight: 30
toc: true
weight: 30 weight: 30
toc: true
--- ---
{{% include "installation/_common/01-editions.md" %}} {{% include "installation/_common/01-editions.md" %}}
+2 -1
View File
@@ -2,12 +2,13 @@
title: macOS title: macOS
description: Install Hugo on macOS. description: Install Hugo on macOS.
categories: [installation] categories: [installation]
keywords: []
menu: menu:
docs: docs:
parent: installation parent: installation
weight: 20 weight: 20
toc: true
weight: 20 weight: 20
toc: true
--- ---
{{% include "installation/_common/01-editions.md" %}} {{% include "installation/_common/01-editions.md" %}}
+2 -1
View File
@@ -2,12 +2,13 @@
title: Windows title: Windows
description: Install Hugo on Windows. description: Install Hugo on Windows.
categories: [installation] categories: [installation]
keywords: []
menu: menu:
docs: docs:
parent: installation parent: installation
weight: 40 weight: 40
toc: true
weight: 40 weight: 40
toc: true
--- ---
{{% include "installation/_common/01-editions.md" %}} {{% include "installation/_common/01-editions.md" %}}
+2 -2
View File
@@ -1,8 +1,8 @@
--- ---
title: Maintenance title: Maintenance
description: Some lists useful for the maintenance of the Hugo docs site. description: Some lists useful for the maintenance of the Hugo docs site.
categories: [maintenance] categories: []
keywords: [maintenance] keywords: []
menu: menu:
docs: docs:
weight: 200 weight: 200
+2 -2
View File
@@ -15,14 +15,14 @@ action:
signatures: [TIME.Month] signatures: [TIME.Month]
--- ---
To convert the time.Month value to a string: To convert the `time.Month` value to a string:
```go-html-template ```go-html-template
{{ $t := time.AsTime "2023-01-27T23:44:58-08:00" }} {{ $t := time.AsTime "2023-01-27T23:44:58-08:00" }}
{{ $t.Month.String }} → January {{ $t.Month.String }} → January
``` ```
To convert the time.Month value to an integer. To convert the `time.Month` value to an integer.
```go-html-template ```go-html-template
{{ $t := time.AsTime "2023-01-27T23:44:58-08:00" }} {{ $t := time.AsTime "2023-01-27T23:44:58-08:00" }}
+2 -2
View File
@@ -10,14 +10,14 @@ action:
signatures: [TIME.Weekday] signatures: [TIME.Weekday]
--- ---
To convert the time.Weekday value to a string: To convert the `time.Weekday` value to a string:
```go-html-template ```go-html-template
{{ $t := time.AsTime "2023-01-27T23:44:58-08:00" }} {{ $t := time.AsTime "2023-01-27T23:44:58-08:00" }}
{{ $t.Weekday.String }} → Friday {{ $t.Weekday.String }} → Friday
``` ```
To convert the time.Weekday value to an integer. To convert the `time.Weekday` value to an integer.
```go-html-template ```go-html-template
{{ $t := time.AsTime "2023-01-27T23:44:58-08:00" }} {{ $t := time.AsTime "2023-01-27T23:44:58-08:00" }}
+1 -1
View File
@@ -1,4 +1,4 @@
--- ---
title: "Hugo News" title: Hugo News
aliases: [/release-notes/] aliases: [/release-notes/]
--- ---
+1 -1
View File
@@ -1,7 +1,7 @@
--- ---
title: Emojis title: Emojis
description: Include emoji shortcodes in your markdown, or use the emojify function in your templates. description: Include emoji shortcodes in your markdown, or use the emojify function in your templates.
categories: [] categories: [quick reference]
keywords: [emoji] keywords: [emoji]
menu: menu:
docs: docs:
+1 -1
View File
@@ -1,7 +1,7 @@
--- ---
title: Functions title: Functions
description: A quick reference guide to Hugo's functions, grouped by namespace. Aliases, if any, appear in parentheses to the right of the function name. description: A quick reference guide to Hugo's functions, grouped by namespace. Aliases, if any, appear in parentheses to the right of the function name.
categories: [] categories: [quick reference]
keywords: [] keywords: []
menu: menu:
docs: docs:
+1 -1
View File
@@ -1,7 +1,7 @@
--- ---
title: Methods title: Methods
description: A quick reference guide to Hugo's methods, grouped by object. description: A quick reference guide to Hugo's methods, grouped by object.
categories: [] categories: [quick reference]
keywords: [] keywords: []
menu: menu:
docs: docs:
+1 -1
View File
@@ -3,7 +3,7 @@ title: Custom 404 page
linkTitle: 404 page linkTitle: 404 page
description: If you know how to create a single page template, you have unlimited options for creating a custom 404. description: If you know how to create a single page template, you have unlimited options for creating a custom 404.
categories: [templates] categories: [templates]
keywords: [404, page not found] keywords: ['404',page not found]
menu: menu:
docs: docs:
parent: templates parent: templates
Loaded 100 of 133 files, more files were not shown because too many files have changed in this diff. Show more