mirror of
https://github.com/gohugoio/hugo.git
synced 2026-08-24 15:28:54 +00:00
Miscellaneous updates
This commit is contained in:
@@ -15,51 +15,51 @@ name = 'Getting started'
|
||||
weight = 30
|
||||
identifier = 'getting-started'
|
||||
pageRef = '/getting-started/'
|
||||
|
||||
[[docs]]
|
||||
name = 'Hugo Modules'
|
||||
weight = 40
|
||||
identifier = 'modules'
|
||||
post = 'break'
|
||||
pageRef = '/hugo-modules/'
|
||||
|
||||
[[docs]]
|
||||
name = 'Content management'
|
||||
weight = 50
|
||||
weight = 40
|
||||
identifier = 'content-management'
|
||||
post = 'expanded'
|
||||
pageRef = '/content-management/'
|
||||
|
||||
[[docs]]
|
||||
name = 'Templates'
|
||||
weight = 60
|
||||
weight = 50
|
||||
identifier = 'templates'
|
||||
pageRef = '/templates/'
|
||||
|
||||
[[docs]]
|
||||
name = 'Functions'
|
||||
weight = 70
|
||||
weight = 60
|
||||
identifier = 'functions'
|
||||
pageRef = '/functions/'
|
||||
|
||||
[[docs]]
|
||||
name = 'Methods'
|
||||
weight = 80
|
||||
weight = 70
|
||||
identifier = 'methods'
|
||||
pageRef = '/methods/'
|
||||
|
||||
[[docs]]
|
||||
name = 'Quick reference'
|
||||
weight = 90
|
||||
weight = 80
|
||||
identifier = 'quick-reference'
|
||||
pageRef = '/quick-reference/'
|
||||
|
||||
[[docs]]
|
||||
name = 'Variables'
|
||||
weight = 95
|
||||
weight = 85
|
||||
identifier = 'variables'
|
||||
pageRef = '/variables/'
|
||||
|
||||
[[docs]]
|
||||
name = 'Hugo Modules'
|
||||
weight = 90
|
||||
identifier = 'modules'
|
||||
pageRef = '/hugo-modules/'
|
||||
|
||||
[[docs]]
|
||||
name = 'Hugo Pipes'
|
||||
weight = 100
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: Benefits of 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.
|
||||
categories: [about]
|
||||
keywords: [ssg,static,performance,security]
|
||||
menu:
|
||||
docs:
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
---
|
||||
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.
|
||||
categories: [about]
|
||||
keywords: []
|
||||
menu:
|
||||
docs:
|
||||
parent: about
|
||||
|
||||
@@ -2,15 +2,15 @@
|
||||
title: Hugo and the General Data Protection Regulation
|
||||
linkTitle: Hugo and the GDPR
|
||||
description: About how to configure your Hugo site to meet the new regulations.
|
||||
layout: single
|
||||
categories: [about]
|
||||
keywords: ["GDPR", "Privacy", "Data Protection"]
|
||||
menu:
|
||||
docs:
|
||||
parent: about
|
||||
weight: 60
|
||||
weight: 60
|
||||
aliases: [/privacy/,/gdpr/]
|
||||
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.
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
---
|
||||
title: License
|
||||
description: Hugo is released under the Apache 2.0 license.
|
||||
categories: ["about hugo"]
|
||||
keywords: ["license","apache"]
|
||||
categories: [about]
|
||||
keywords: [license,apache]
|
||||
menu:
|
||||
docs:
|
||||
parent: about
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
---
|
||||
title: Hugo's security model
|
||||
description: A summary of Hugo's security model.
|
||||
layout: single
|
||||
keywords: ["Security", "Privacy"]
|
||||
categories: [about]
|
||||
keywords: [security,privacy]
|
||||
menu:
|
||||
docs:
|
||||
parent: about
|
||||
weight: 50
|
||||
weight: 50
|
||||
aliases: [/security/]
|
||||
toc: true
|
||||
aliases: [/security/]
|
||||
---
|
||||
|
||||
## Runtime security
|
||||
|
||||
@@ -1,14 +1,15 @@
|
||||
---
|
||||
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.
|
||||
layout: single
|
||||
categories: [about]
|
||||
keywords: []
|
||||
menu:
|
||||
docs:
|
||||
parent: about
|
||||
weight: 20
|
||||
weight: 20
|
||||
aliases: [/overview/introduction/,/about/why-i-built-hugo/]
|
||||
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.
|
||||
|
||||
@@ -2,13 +2,13 @@
|
||||
title: Content management
|
||||
linkTitle: Overview
|
||||
description: Hugo makes managing large static sites easy with support for archetypes, content types, menus, cross references, summaries, and more.
|
||||
categories: []
|
||||
keywords: []
|
||||
menu:
|
||||
docs:
|
||||
identifier: content-management-overview
|
||||
parent: content-management
|
||||
weight: 10
|
||||
keywords: [source, organization]
|
||||
categories: [content management]
|
||||
weight: 10
|
||||
aliases: [/content/,/content/organization]
|
||||
---
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
---
|
||||
title: Archetypes
|
||||
description: An archetype is a template for new content.
|
||||
keywords: [archetypes,generators,metadata,front matter]
|
||||
categories: [content management]
|
||||
keywords: [archetypes,generators,metadata,front matter]
|
||||
menu:
|
||||
docs:
|
||||
parent: content-management
|
||||
weight: 140
|
||||
quicklinks:
|
||||
toc: true
|
||||
weight: 140
|
||||
toc: true
|
||||
aliases: [/content/archetypes/]
|
||||
---
|
||||
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
---
|
||||
title: Build options
|
||||
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]
|
||||
categories: [fundamentals,content management]
|
||||
menu:
|
||||
docs:
|
||||
parent: content-management
|
||||
weight: 70
|
||||
toc: true
|
||||
weight: 70
|
||||
toc: true
|
||||
aliases: [/content/build-options/]
|
||||
---
|
||||
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
---
|
||||
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.
|
||||
categories: [content management]
|
||||
keywords: [sections,content,organization]
|
||||
categories: [project organization]
|
||||
menu:
|
||||
docs:
|
||||
parent: content-management
|
||||
weight: 220
|
||||
toc: true
|
||||
weight: 220
|
||||
toc: true
|
||||
aliases: [/extras/comments/]
|
||||
---
|
||||
|
||||
|
||||
@@ -2,13 +2,13 @@
|
||||
title: Links and cross references
|
||||
description: Shortcodes for creating links to documents.
|
||||
categories: [content management]
|
||||
keywords: ["cross references","references", "anchors", "urls"]
|
||||
keywords: [cross references,references,anchors,urls]
|
||||
menu:
|
||||
docs:
|
||||
parent: content-management
|
||||
weight: 170
|
||||
toc: true
|
||||
weight: 170
|
||||
toc: true
|
||||
aliases: [/extras/crossreferences/]
|
||||
---
|
||||
|
||||
|
||||
@@ -7,8 +7,8 @@ menu:
|
||||
docs:
|
||||
parent: content-management
|
||||
weight: 50
|
||||
toc: true
|
||||
weight: 50
|
||||
toc: true
|
||||
---
|
||||
{{< new-in "0.93.0" >}}
|
||||
|
||||
|
||||
@@ -7,8 +7,8 @@ menu:
|
||||
docs:
|
||||
parent: content-management
|
||||
weight: 40
|
||||
toc: true
|
||||
weight: 40
|
||||
toc: true
|
||||
aliases: [/content/markdown-extras/,/content/supported-formats/,/doc/supported-formats/]
|
||||
---
|
||||
|
||||
|
||||
@@ -2,13 +2,13 @@
|
||||
title: Front matter
|
||||
description: Hugo allows you to add front matter in yaml, toml, or json to your content files.
|
||||
categories: [content management]
|
||||
keywords: ["front matter", "yaml", "toml", "json", "metadata", "archetypes"]
|
||||
keywords: [front matter,yaml,toml,json,metadata,archetypes]
|
||||
menu:
|
||||
docs:
|
||||
parent: content-management
|
||||
weight: 60
|
||||
toc: true
|
||||
weight: 60
|
||||
toc: true
|
||||
aliases: [/content/front-matter/]
|
||||
---
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
---
|
||||
title: Image processing
|
||||
description: Resize, crop, rotate, filter, and convert images.
|
||||
categories: [fundamentals,content management]
|
||||
keywords: [resources, images]
|
||||
categories: [content management,fundamentals]
|
||||
keywords: [resources,images]
|
||||
menu:
|
||||
docs:
|
||||
parent: content-management
|
||||
|
||||
@@ -7,8 +7,8 @@ menu:
|
||||
docs:
|
||||
parent: content-management
|
||||
weight: 190
|
||||
toc: true
|
||||
weight: 190
|
||||
toc: true
|
||||
aliases: [/extras/menus/]
|
||||
---
|
||||
|
||||
|
||||
@@ -3,13 +3,13 @@ title: Multilingual mode
|
||||
linkTitle: Multilingual
|
||||
description: Hugo supports the creation of websites with multiple languages side by side.
|
||||
categories: [content management]
|
||||
keywords: [multilingual,i18n, internationalization]
|
||||
keywords: [multilingual,i18n,internationalization]
|
||||
menu:
|
||||
docs:
|
||||
parent: content-management
|
||||
weight: 230
|
||||
toc: true
|
||||
weight: 230
|
||||
toc: true
|
||||
aliases: [/content/multilingual/,/tutorials/create-a-multilingual-site/]
|
||||
---
|
||||
|
||||
|
||||
@@ -2,14 +2,14 @@
|
||||
title: Content organization
|
||||
linkTitle: Organization
|
||||
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]
|
||||
menu:
|
||||
docs:
|
||||
parent: content-management
|
||||
weight: 20
|
||||
toc: true
|
||||
weight: 20
|
||||
toc: true
|
||||
aliases: [/content/sections/]
|
||||
---
|
||||
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
---
|
||||
title: Page bundles
|
||||
description: Content organization using Page Bundles
|
||||
keywords: [page, bundle, leaf, branch]
|
||||
categories: [content management]
|
||||
keywords: [page,bundle,leaf,branch]
|
||||
menu :
|
||||
docs:
|
||||
parent: content-management
|
||||
weight: 30
|
||||
toc: true
|
||||
weight: 30
|
||||
toc: true
|
||||
---
|
||||
|
||||
Page Bundles are a way to group [Page Resources](/content-management/page-resources/).
|
||||
|
||||
@@ -7,8 +7,8 @@ menu:
|
||||
docs:
|
||||
parent: content-management
|
||||
weight: 80
|
||||
toc: true
|
||||
weight: 80
|
||||
toc: true
|
||||
---
|
||||
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
|
||||
|
||||
@@ -7,8 +7,8 @@ menu:
|
||||
docs:
|
||||
parent: content-management
|
||||
weight: 110
|
||||
toc: true
|
||||
weight: 110
|
||||
toc: true
|
||||
aliases: [/content/related/,/related/]
|
||||
---
|
||||
|
||||
|
||||
@@ -8,8 +8,8 @@ menu:
|
||||
docs:
|
||||
parent: content-management
|
||||
weight: 120
|
||||
toc: true
|
||||
weight: 120
|
||||
toc: true
|
||||
aliases: [/content/sections/]
|
||||
---
|
||||
|
||||
|
||||
@@ -7,8 +7,8 @@ menu:
|
||||
docs:
|
||||
parent: content-management
|
||||
weight: 100
|
||||
toc: true
|
||||
weight: 100
|
||||
toc: true
|
||||
aliases: [/extras/shortcodes/]
|
||||
testparam: "Hugo Rocks!"
|
||||
---
|
||||
|
||||
@@ -7,8 +7,8 @@ menu:
|
||||
docs:
|
||||
parent: content-management
|
||||
weight: 200
|
||||
toc: true
|
||||
weight: 200
|
||||
toc: true
|
||||
aliases: [/static-files]
|
||||
---
|
||||
|
||||
|
||||
@@ -8,8 +8,8 @@ menu:
|
||||
docs:
|
||||
parent: content-management
|
||||
weight: 160
|
||||
toc: true
|
||||
weight: 160
|
||||
toc: true
|
||||
aliases: [/content/summaries/,/content-management/content-summaries/]
|
||||
---
|
||||
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
---
|
||||
title: Syntax highlighting
|
||||
description: Hugo comes with really fast syntax highlighting from Chroma.
|
||||
keywords: [highlighting,chroma,code blocks,syntax]
|
||||
categories: [content management]
|
||||
keywords: [highlighting,chroma,code blocks,syntax]
|
||||
menu:
|
||||
docs:
|
||||
parent: content-management
|
||||
weight: 240
|
||||
toc: true
|
||||
weight: 240
|
||||
toc: true
|
||||
aliases: [/extras/highlighting/,/extras/highlight/,/tools/syntax-highlighting/]
|
||||
---
|
||||
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
---
|
||||
title: Taxonomies
|
||||
description: Hugo includes support for user-defined taxonomies.
|
||||
keywords: [taxonomies,metadata,front matter,terms]
|
||||
categories: [content management]
|
||||
keywords: [taxonomies,metadata,front matter,terms]
|
||||
menu:
|
||||
docs:
|
||||
parent: content-management
|
||||
weight: 150
|
||||
toc: true
|
||||
weight: 150
|
||||
toc: true
|
||||
aliases: [/taxonomies/overview/,/taxonomies/usage/,/indexes/overview/,/doc/indexes/,/extras/indexes]
|
||||
---
|
||||
|
||||
|
||||
@@ -7,8 +7,8 @@ menu:
|
||||
docs:
|
||||
parent: content-management
|
||||
weight: 210
|
||||
toc: true
|
||||
weight: 210
|
||||
toc: true
|
||||
aliases: [/extras/toc/]
|
||||
---
|
||||
|
||||
|
||||
@@ -2,13 +2,13 @@
|
||||
title: Content types
|
||||
description: Hugo is built around content organized in sections.
|
||||
categories: [content management]
|
||||
keywords: [lists, sections, content types, types, organization]
|
||||
keywords: [lists,sections,content types,types,organization]
|
||||
menu:
|
||||
docs:
|
||||
parent: content-management
|
||||
weight: 130
|
||||
toc: true
|
||||
weight: 130
|
||||
toc: true
|
||||
aliases: [/content/types]
|
||||
---
|
||||
|
||||
|
||||
@@ -7,8 +7,8 @@ menu:
|
||||
docs:
|
||||
parent: content-management
|
||||
weight: 180
|
||||
toc: true
|
||||
weight: 180
|
||||
toc: true
|
||||
aliases: [/extras/permalinks/,/extras/aliases/,/extras/urls/,/doc/redirects/,/doc/alias/,/doc/aliases/]
|
||||
---
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: Contribute to the Hugo project
|
||||
linkTitle: Overview
|
||||
description: Contribute to Hugo development and documentation.
|
||||
categories: [contribute]
|
||||
categories: []
|
||||
keywords: []
|
||||
menu:
|
||||
docs:
|
||||
|
||||
@@ -9,8 +9,8 @@ menu:
|
||||
parent: contribute
|
||||
weight: 40
|
||||
weight: 40
|
||||
aliases: [/contribute/theme/]
|
||||
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.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: collections.Group
|
||||
description: Groups a list of pages.
|
||||
description: Groups the given page collection by the given key.
|
||||
categories: []
|
||||
keywords: []
|
||||
action:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: collections.Slice
|
||||
description: Creates a slice (array) of all passed arguments.
|
||||
description: Creates a slice of all passed arguments.
|
||||
categories: []
|
||||
keywords: []
|
||||
action:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: encoding.Jsonify
|
||||
description: Encodes a given object to JSON.
|
||||
description: Encodes the given object to JSON.
|
||||
categories: []
|
||||
keywords: []
|
||||
action:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: site
|
||||
description: Provides global access to the Site object.
|
||||
description: Provides global access to the current Site object.
|
||||
categories: []
|
||||
keywords: []
|
||||
action:
|
||||
|
||||
@@ -21,7 +21,7 @@ toc: true
|
||||
```go-html-template
|
||||
{{ $s := slice "foo" "bar" "baz" }}
|
||||
{{ range $var }}
|
||||
{{ . }} → foo "bar" "baz"
|
||||
{{ . }} → foo bar baz
|
||||
{{ end }}
|
||||
```
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
{{% 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
|
||||
[page]: /getting-started/glossary/#page-resource
|
||||
[remote]: /getting-started/glossary/#remote-resource
|
||||
{{% /note %}}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: reflect.IsMap
|
||||
description: Reports whether the value is a map.
|
||||
description: Reports whether the given value is a map.
|
||||
categories: []
|
||||
keywords: []
|
||||
action:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: reflect.IsSlice
|
||||
description: Reports whether the value is a slice.
|
||||
description: Reports whether the given value is a slice.
|
||||
categories: []
|
||||
keywords: []
|
||||
action:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: safe.CSS
|
||||
description: Declares the provided string as safe CSS string.
|
||||
description: Declares the given string as safe CSS string.
|
||||
categories: []
|
||||
keywords: []
|
||||
action:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: safe.HTML
|
||||
description: Declares a provided string as a safeHTML string.
|
||||
description: Declares the given string as a safeHTML string.
|
||||
categories: []
|
||||
keywords: []
|
||||
action:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
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: []
|
||||
keywords: []
|
||||
action:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: safe.JS
|
||||
description: Declares the provided string as a safe JavaScript string.
|
||||
description: Declares the given string as a safe JavaScript expression.
|
||||
categories: []
|
||||
keywords: []
|
||||
action:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
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: []
|
||||
keywords: []
|
||||
action:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
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: []
|
||||
keywords: []
|
||||
action:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: strings.FirstUpper
|
||||
description: Capitalizes the first character of a given string.
|
||||
description: Returns the given string, capitalizing the first character.
|
||||
categories: []
|
||||
keywords: []
|
||||
action:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: strings.ToLower
|
||||
description: Converts all characters in the given string to lowercase.
|
||||
description: Returns the given string, converting all characters to lowercase.
|
||||
categories: []
|
||||
keywords: []
|
||||
action:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: strings.ToUpper
|
||||
description: Converts all characters in the given string to uppercase.
|
||||
description: Returns the given string, converting all characters to uppercase.
|
||||
categories: []
|
||||
keywords: []
|
||||
action:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
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: []
|
||||
keywords: []
|
||||
action:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
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: []
|
||||
keywords: []
|
||||
action:
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
title: Getting started
|
||||
linkTitle: Overview
|
||||
description: Quick start and guides for installing Hugo on your preferred operating system.
|
||||
categories: [getting started]
|
||||
keywords: [usage,docs]
|
||||
categories: []
|
||||
keywords: []
|
||||
menu:
|
||||
docs:
|
||||
identifier: getting-started-overview
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Configure markup
|
||||
description: Configure rendering of markup to HTML.
|
||||
categories: [fundamentals, getting started]
|
||||
categories: [getting started,fundamentals]
|
||||
keywords: [configuration,highlighting]
|
||||
menu:
|
||||
docs:
|
||||
|
||||
@@ -2,15 +2,15 @@
|
||||
title: Configure Hugo
|
||||
linkTitle: Configuration
|
||||
description: How to configure your Hugo site.
|
||||
categories: [fundamentals,getting started]
|
||||
categories: [getting started,fundamentals]
|
||||
keywords: [configuration,toml,yaml,json]
|
||||
menu:
|
||||
docs:
|
||||
parent: getting-started
|
||||
weight: 40
|
||||
weight: 40
|
||||
aliases: [/overview/source-directory/,/overview/configuration/]
|
||||
toc: true
|
||||
aliases: [/overview/source-directory/,/overview/configuration/]
|
||||
---
|
||||
|
||||
## Configuration file
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
---
|
||||
title: Directory structure
|
||||
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]
|
||||
menu:
|
||||
docs:
|
||||
parent: getting-started
|
||||
weight: 30
|
||||
weight: 30
|
||||
aliases: [/overview/source-directory/]
|
||||
toc: true
|
||||
aliases: [/overview/source-directory/]
|
||||
---
|
||||
|
||||
## Site skeleton
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: External learning resources
|
||||
description: A list of tutorials and books on Hugo.
|
||||
categories: [getting started]
|
||||
keywords: [books, tutorials, learning, usage]
|
||||
menu:
|
||||
docs:
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Glossary of terms
|
||||
description: Terms commonly used throughout the documentation.
|
||||
categories: [getting started]
|
||||
keywords: [glossary]
|
||||
menu:
|
||||
docs:
|
||||
|
||||
@@ -8,8 +8,8 @@ menu:
|
||||
parent: getting-started
|
||||
weight: 30
|
||||
weight: 30
|
||||
aliases: [/overview/usage/,/extras/livereload/,/doc/usage/,/usage/]
|
||||
toc: true
|
||||
aliases: [/overview/usage/,/extras/livereload/,/doc/usage/,/usage/]
|
||||
---
|
||||
|
||||
## Test your installation
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: Hosting and deployment
|
||||
linkTitle: Overview
|
||||
description: Site builds, automated deployments, and popular hosting solutions.
|
||||
categories: [hosting and deployment]
|
||||
categories: []
|
||||
keywords: []
|
||||
menu:
|
||||
docs:
|
||||
|
||||
@@ -2,12 +2,12 @@
|
||||
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.
|
||||
categories: [hosting and deployment]
|
||||
keywords: [rclone,sftp,deployment]
|
||||
keywords: [deployment,rclone,sftp]
|
||||
menu:
|
||||
docs:
|
||||
parent: hosting-and-deployment
|
||||
aliases: [/tutorials/deployment-with-rclone/]
|
||||
toc: true
|
||||
aliases: [/tutorials/deployment-with-rclone/]
|
||||
---
|
||||
|
||||
## Assumptions
|
||||
|
||||
@@ -2,12 +2,12 @@
|
||||
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.
|
||||
categories: [hosting and deployment]
|
||||
keywords: [rsync,deployment]
|
||||
keywords: [deployment,rsync]
|
||||
menu:
|
||||
docs:
|
||||
parent: hosting-and-deployment
|
||||
aliases: [/tutorials/deployment-with-rsync/]
|
||||
toc: true
|
||||
aliases: [/tutorials/deployment-with-rsync/]
|
||||
---
|
||||
|
||||
## Assumptions
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: Host on 21YunBox
|
||||
description: Host your Hugo site with 21YunBox's blazing fast Chinese CDN, fully-managed SSL and auto deploys from Gitee.
|
||||
categories: [hosting and deployment]
|
||||
keywords: [21yunbox,hosting,deployment]
|
||||
keywords: [hosting,21yunbox]
|
||||
menu:
|
||||
docs:
|
||||
parent: hosting-and-deployment
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: Host on AWS Amplify
|
||||
description: Develop and deploy a cloud-powered web app with AWS Amplify.
|
||||
categories: [hosting and deployment]
|
||||
keywords: [amplify,hosting,deployment]
|
||||
keywords: [hosting,amplify]
|
||||
menu:
|
||||
docs:
|
||||
parent: hosting-and-deployment
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: Host on Azure Static Web Apps
|
||||
description: Publish a Hugo site to Azure Static Web Apps.
|
||||
categories: [hosting and deployment]
|
||||
keywords: [hosting,Azure Static Web Apps]
|
||||
keywords: [hosting,azure]
|
||||
menu:
|
||||
docs:
|
||||
parent: hosting-and-deployment
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
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.
|
||||
categories: [hosting and deployment]
|
||||
keywords: [hosting,cloudflare]
|
||||
menu:
|
||||
docs:
|
||||
parent: hosting-and-deployment
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
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
|
||||
categories: [hosting and deployment]
|
||||
keywords: [github,git,deployment,hosting]
|
||||
keywords: [hosting,github]
|
||||
menu:
|
||||
docs:
|
||||
parent: hosting-and-deployment
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
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.
|
||||
categories: [hosting and deployment]
|
||||
keywords: [hosting,deployment,git,gitlab]
|
||||
keywords: [hosting,gitlab]
|
||||
menu:
|
||||
docs:
|
||||
parent: hosting-and-deployment
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
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."
|
||||
categories: [hosting and deployment]
|
||||
keywords: [keycdn,hosting,deployment,cdn]
|
||||
keywords: [hosting,keycdn]
|
||||
menu:
|
||||
docs:
|
||||
parent: hosting-and-deployment
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
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.
|
||||
categories: [hosting and deployment]
|
||||
keywords: [netlify,hosting,deployment]
|
||||
keywords: [hosting,netlify]
|
||||
menu:
|
||||
docs:
|
||||
parent: hosting-and-deployment
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: Host on Render
|
||||
description: Host your Hugo site for free with Render's global CDN, fully-managed SSL and auto deploys from GitHub.
|
||||
categories: [hosting and deployment]
|
||||
keywords: [hosting,deployment]
|
||||
keywords: [hosting]
|
||||
menu:
|
||||
docs:
|
||||
parent: hosting-and-deployment
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: Hugo Deploy
|
||||
description: You can upload your site to GCS, S3, or Azure using the Hugo CLI.
|
||||
categories: [hosting and deployment]
|
||||
keywords: [s3,gcs,azure,hosting,deployment]
|
||||
keywords: [deployment,s3,gcs,azure]
|
||||
menu:
|
||||
docs:
|
||||
parent: hosting-and-deployment
|
||||
|
||||
@@ -2,16 +2,16 @@
|
||||
title: Hugo Modules
|
||||
linkTitle: Overview
|
||||
description: How to use Hugo Modules.
|
||||
categories: []
|
||||
keywords: []
|
||||
menu:
|
||||
docs:
|
||||
identifier: hugo-modules-overview
|
||||
parent: modules
|
||||
weight: 10
|
||||
weight: 10
|
||||
categories: [hugo modules]
|
||||
keywords: [themes,modules]
|
||||
aliases: [/themes/overview/,/themes/]
|
||||
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**.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: Configure Hugo modules
|
||||
description: This page describes the configuration options for a module.
|
||||
categories: [hugo modules]
|
||||
keywords: [themes, source, organization, directories]
|
||||
keywords: [modules,themes]
|
||||
menu:
|
||||
docs:
|
||||
parent: modules
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: Theme components
|
||||
description: Hugo provides advanced theming support with Theme Components.
|
||||
categories: [hugo modules]
|
||||
keywords: [themes, theme, source, organization, directories]
|
||||
keywords: [modules,themes]
|
||||
menu:
|
||||
docs:
|
||||
parent: modules
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: Use Hugo Modules
|
||||
description: How to use Hugo Modules to build and manage your site.
|
||||
categories: [hugo modules]
|
||||
keywords: [install, themes, source, organization, directories,usage,modules]
|
||||
keywords: [modules,themes]
|
||||
menu:
|
||||
docs:
|
||||
parent: modules
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Hugo Pipes
|
||||
linkTitle: Overview
|
||||
categories: [asset management]
|
||||
categories: []
|
||||
keywords: []
|
||||
menu:
|
||||
docs:
|
||||
|
||||
@@ -8,7 +8,7 @@ menu:
|
||||
parent: hugo-pipes
|
||||
weight: 70
|
||||
weight: 70
|
||||
function:
|
||||
action:
|
||||
aliases: [babel]
|
||||
returnType: resource.Resource
|
||||
signatures: ['resources.Babel [OPTIONS] RESOURCE']
|
||||
|
||||
@@ -9,7 +9,7 @@ menu:
|
||||
parent: hugo-pipes
|
||||
weight: 90
|
||||
weight: 90
|
||||
function:
|
||||
action:
|
||||
aliases: []
|
||||
returnType: resource.Resource
|
||||
signatures: ['resources.Concat TARGETPATH [RESOURCE...]']
|
||||
|
||||
@@ -9,10 +9,10 @@ menu:
|
||||
parent: hugo-pipes
|
||||
weight: 100
|
||||
weight: 100
|
||||
function:
|
||||
action:
|
||||
aliases: [fingerprint]
|
||||
returnType: resource.Resource
|
||||
signatures: ['resources.Fingerprint RESOURCE [ALGORITHM]']
|
||||
signatures: ['resources.Fingerprint [ALGORITHM] RESOURCE']
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -9,7 +9,7 @@ menu:
|
||||
parent: hugo-pipes
|
||||
weight: 60
|
||||
weight: 60
|
||||
function:
|
||||
action:
|
||||
aliases: []
|
||||
returnType: resource.Resource
|
||||
signatures: ['js.Build [OPTIONS] RESOURCE']
|
||||
|
||||
@@ -9,7 +9,7 @@ menu:
|
||||
parent: hugo-pipes
|
||||
weight: 80
|
||||
weight: 80
|
||||
function:
|
||||
action:
|
||||
aliases: [minify]
|
||||
returnType: resource.Resource
|
||||
signatures: [resources.Minify RESOURCE]
|
||||
|
||||
@@ -7,9 +7,9 @@ menu:
|
||||
docs:
|
||||
parent: hugo-pipes
|
||||
weight: 40
|
||||
toc: true
|
||||
weight: 40
|
||||
function:
|
||||
toc: true
|
||||
action:
|
||||
aliases: [postCSS]
|
||||
returnType: resource.Resource
|
||||
signatures: ['resources.PostCSS [OPTIONS] RESOURCE']
|
||||
|
||||
@@ -8,7 +8,7 @@ menu:
|
||||
parent: hugo-pipes
|
||||
weight: 50
|
||||
weight: 50
|
||||
function:
|
||||
action:
|
||||
aliases: []
|
||||
returnType: postpub.PostPublishedResource
|
||||
signatures: [resources.PostProcess RESOURCE]
|
||||
|
||||
@@ -9,7 +9,7 @@ menu:
|
||||
parent: hugo-pipes
|
||||
weight: 110
|
||||
weight: 110
|
||||
function:
|
||||
action:
|
||||
aliases: []
|
||||
returnType: resource.Resource
|
||||
signatures: [resources.FromString TARGETPATH STRING]
|
||||
|
||||
@@ -9,10 +9,10 @@ menu:
|
||||
parent: hugo-pipes
|
||||
weight: 120
|
||||
weight: 120
|
||||
function:
|
||||
action:
|
||||
aliases: []
|
||||
returnType: resource.Resource
|
||||
signatures: [resources.ExecuteAsTemplate TARGETPATH CONTEXT RESOURCE']
|
||||
signatures: [resources.ExecuteAsTemplate TARGETPATH CONTEXT RESOURCE]
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -10,8 +10,9 @@ menu:
|
||||
returnType: resource.Resource
|
||||
weight: 30
|
||||
weight: 30
|
||||
function:
|
||||
action:
|
||||
aliases: [toCSS]
|
||||
returnType: resource.Resource
|
||||
signatures: ['resources.ToCSS [OPTIONS] RESOURCE']
|
||||
toc: true
|
||||
aliases: [/hugo-pipes/transform-to-css/]
|
||||
|
||||
@@ -3,8 +3,8 @@ title: Installation
|
||||
linkTitle: Overview
|
||||
description: Install Hugo on macOS, Linux, Windows, BSD, and on any machine that can run the Go compiler tool chain.
|
||||
aliases: [/getting-started/installing/]
|
||||
categories: [installation]
|
||||
keywords: [installation]
|
||||
categories: []
|
||||
keywords: []
|
||||
menu:
|
||||
docs:
|
||||
identifier: installation-overview
|
||||
|
||||
@@ -2,12 +2,13 @@
|
||||
title: BSD
|
||||
description: Install Hugo on BSD derivatives.
|
||||
categories: [installation]
|
||||
keywords: []
|
||||
menu:
|
||||
docs:
|
||||
parent: installation
|
||||
weight: 50
|
||||
toc: true
|
||||
weight: 50
|
||||
toc: true
|
||||
---
|
||||
{{% include "installation/_common/01-editions.md" %}}
|
||||
|
||||
|
||||
@@ -2,12 +2,13 @@
|
||||
title: Linux
|
||||
description: Install Hugo on Linux.
|
||||
categories: [installation]
|
||||
keywords: []
|
||||
menu:
|
||||
docs:
|
||||
parent: installation
|
||||
weight: 30
|
||||
toc: true
|
||||
weight: 30
|
||||
toc: true
|
||||
---
|
||||
{{% include "installation/_common/01-editions.md" %}}
|
||||
|
||||
|
||||
@@ -2,12 +2,13 @@
|
||||
title: macOS
|
||||
description: Install Hugo on macOS.
|
||||
categories: [installation]
|
||||
keywords: []
|
||||
menu:
|
||||
docs:
|
||||
parent: installation
|
||||
weight: 20
|
||||
toc: true
|
||||
weight: 20
|
||||
toc: true
|
||||
---
|
||||
{{% include "installation/_common/01-editions.md" %}}
|
||||
|
||||
|
||||
@@ -2,12 +2,13 @@
|
||||
title: Windows
|
||||
description: Install Hugo on Windows.
|
||||
categories: [installation]
|
||||
keywords: []
|
||||
menu:
|
||||
docs:
|
||||
parent: installation
|
||||
weight: 40
|
||||
toc: true
|
||||
weight: 40
|
||||
toc: true
|
||||
---
|
||||
{{% include "installation/_common/01-editions.md" %}}
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
---
|
||||
title: Maintenance
|
||||
description: Some lists useful for the maintenance of the Hugo docs site.
|
||||
categories: [maintenance]
|
||||
keywords: [maintenance]
|
||||
categories: []
|
||||
keywords: []
|
||||
menu:
|
||||
docs:
|
||||
weight: 200
|
||||
|
||||
@@ -15,14 +15,14 @@ action:
|
||||
signatures: [TIME.Month]
|
||||
---
|
||||
|
||||
To convert the time.Month value to a string:
|
||||
To convert the `time.Month` value to a string:
|
||||
|
||||
```go-html-template
|
||||
{{ $t := time.AsTime "2023-01-27T23:44:58-08:00" }}
|
||||
{{ $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
|
||||
{{ $t := time.AsTime "2023-01-27T23:44:58-08:00" }}
|
||||
|
||||
@@ -10,14 +10,14 @@ action:
|
||||
signatures: [TIME.Weekday]
|
||||
---
|
||||
|
||||
To convert the time.Weekday value to a string:
|
||||
To convert the `time.Weekday` value to a string:
|
||||
|
||||
```go-html-template
|
||||
{{ $t := time.AsTime "2023-01-27T23:44:58-08:00" }}
|
||||
{{ $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
|
||||
{{ $t := time.AsTime "2023-01-27T23:44:58-08:00" }}
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Hugo News"
|
||||
title: Hugo News
|
||||
aliases: [/release-notes/]
|
||||
---
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Emojis
|
||||
description: Include emoji shortcodes in your markdown, or use the emojify function in your templates.
|
||||
categories: []
|
||||
categories: [quick reference]
|
||||
keywords: [emoji]
|
||||
menu:
|
||||
docs:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
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.
|
||||
categories: []
|
||||
categories: [quick reference]
|
||||
keywords: []
|
||||
menu:
|
||||
docs:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Methods
|
||||
description: A quick reference guide to Hugo's methods, grouped by object.
|
||||
categories: []
|
||||
categories: [quick reference]
|
||||
keywords: []
|
||||
menu:
|
||||
docs:
|
||||
|
||||
@@ -3,7 +3,7 @@ title: Custom 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.
|
||||
categories: [templates]
|
||||
keywords: [404, page not found]
|
||||
keywords: ['404',page not found]
|
||||
menu:
|
||||
docs:
|
||||
parent: templates
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user