List template functions by namespace

Closes gohugoio#53 Closes gohugoio#447 Closes gohugoio#546 Closes gohugoio#1400 Closes gohugoio#1406 Closes gohugoio#1547 Closes gohugoio#1622 Closes gohugoio#1637 Closes gohugoio#1639 Closes gohugoio#1667 Closes gohugoio#1745 Closes gohugoio#2001 Closes gohugoio#2256 Closes gohugoio#2264 Closes gohugoio#2275 Closes gohugoio#2276
jmooring · Oct 27, 2023 · b1a70c2 · b1a70c2
1 parent 8182a27
commit b1a70c2
Show file tree

Hide file tree

Showing 628 changed files with 18,234 additions and 4,927 deletions.
diff --git a/.cspell.json b/.cspell.json
@@ -335,7 +335,7 @@
     "مدونتي"
   ],
   "language": "en,en-US,de,fr",
-  "allowCompoundWords": true,
+  "allowCompoundWords": false,
   "files": [
     "**/*.md"
   ],

diff --git a/LICENSE.md b/LICENSE.md
diff --git a/README.md b/README.md
@@ -19,12 +19,11 @@ 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:
 
-```
+```sh
 HUGO_MODULE_WORKSPACE=hugo.work hugo server --ignoreVendorPaths "**"
 ```
 
@@ -37,15 +36,15 @@ HUGO_MODULE_WORKSPACE=hugo.work hugo server --ignoreVendorPaths "**"
 
 To view the documentation site locally, you need to clone this repository:
 
-```bash
+```sh
 git clone https://github.com/gohugoio/hugoDocs.git
 ```
 
 Also note that the documentation version for a given version of Hugo can also be found in the `/docs` sub-folder of the [Hugo source repository](https://github.com/gohugoio/hugo).
 
 Then to view the docs in your browser, run Hugo and open up the link:
 
-```bash
+```sh
 ▶ hugo server
 
 Started building sites ...

diff --git a/archetypes/functions.md b/archetypes/functions.md
@@ -1,14 +1,11 @@
 ---
 title: {{ replace .File.ContentBaseName "-" " " | title }}
 description:
-categories: [functions]
+categories: []
 keywords: []
-menu:
-  docs:
-    parent: functions
-function:
+action:
   aliases: []
+  related: []
   returnType:
   signatures: []
-relatedFunctions: []
 ---
diff --git a/archetypes/methods.md b/archetypes/methods.md
@@ -0,0 +1,10 @@
+---
+title: {{ replace .File.ContentBaseName "-" " " | title }}
+description:
+categories: []
+keywords: []
+action:
+  related: []
+  returnType:
+  signatures: []
+---
diff --git a/archetypes/showcase/bio.md b/archetypes/showcase/bio.md
@@ -3,6 +3,5 @@ Add some **general info** about {{ replace .Name "-" " " | title }} here.
 
 The site is built by:
 
-* [Person 1](https://example.com)
-* [Person 1](https://example.com)
-
+* [Person 1](https://example.org)
+* [Person 1](https://example.org)
diff --git a/assets/images/examples/zion-national-park-grayscale.jpg b/assets/images/examples/zion-national-park-grayscale.jpg
diff --git a/assets/images/examples/zion-national-park.jpg b/assets/images/examples/zion-national-park.jpg
diff --git a/assets/images/logos/logo-128x128.png b/assets/images/logos/logo-128x128.png
diff --git a/assets/images/logos/logo-256x256.png b/assets/images/logos/logo-256x256.png
diff --git a/assets/images/logos/logo-512x512.png b/assets/images/logos/logo-512x512.png
diff --git a/assets/images/logos/logo-64x64.png b/assets/images/logos/logo-64x64.png
diff --git a/assets/images/logos/logo-96x96.png b/assets/images/logos/logo-96x96.png
diff --git a/config/_default/menus/menus.en.toml b/config/_default/menus/menus.en.toml
@@ -45,8 +45,14 @@
   url = "/functions/"
 
 [[docs]]
-  name = "Variables"
+  name = "Methods"
   weight = 80
+  identifier = "methods"
+  url = "/methods/"
+
+[[docs]]
+  name = "Variables"
+  weight = 85
   identifier = "variables"
   url = "/variables/"
 

diff --git a/config/_default/params.toml b/config/_default/params.toml
@@ -22,3 +22,6 @@ flex_box_interior_classes = "flex-auto w-100 w-40-l mr3 mb3 bg-white ba b--moon-
 
 [social]
 twitter = "GoHugoIO"
+
+[render_hooks.link]
+errorLevel = 'warning' # ignore (default), warning, or error (fails the build)
diff --git a/content/en/about/hugo-and-gdpr.md b/content/en/about/hugo-and-gdpr.md
@@ -29,7 +29,7 @@ toc: true
 
 Below are all privacy settings and their default value. These settings need to be put in your site configuration (e.g. `hugo.toml`).
 
-{{< code-toggle file="hugo" >}}
+{{< code-toggle file=hugo >}}
 [privacy]
 [privacy.disqus]
 disable = false
@@ -58,7 +58,7 @@ privacyEnhanced = false
 
 An example privacy configuration that disables all the relevant services in Hugo. With this configuration, the other settings will not matter.
 
-{{< code-toggle file="hugo" >}}
+{{< code-toggle file=hugo >}}
 [privacy]
 [privacy.disqus]
 disable = true
@@ -98,7 +98,7 @@ simple
 
 **Note:** If you use the _simple mode_ for Instagram and a site styled with Bootstrap 4, you may want to disable the inline styles provided by Hugo:
 
- {{< code-toggle file="hugo" >}}
+{{< code-toggle file=hugo >}}
 [services]
 [services.instagram]
 disableInlineCSS = true
@@ -114,7 +114,7 @@ simple
 
 **Note:** If you use the _simple mode_ for Twitter, you may want to disable the inline styles provided by Hugo:
 
- {{< code-toggle file="hugo" >}}
+{{< code-toggle file=hugo >}}
 [services]
 [services.twitter]
 disableInlineCSS = true

diff --git a/content/en/about/license.md b/content/en/about/license.md
diff --git a/content/en/content-management/_common/_index.md b/content/en/content-management/_common/_index.md
@@ -0,0 +1,12 @@
+---
+_build:
+  list: never
+  publishResources: false
+  render: never
+---
+
+<!--
+Files within this headless branch bundle are markdown snippets. Each file must contain front matter delimiters, though front matter fields are not required.
+
+Include the rendered content using the "include" shortcode. 
+-->
diff --git a/layouts/shortcodes/page-kinds.html → .../content-management/_common/page-kinds.md b/layouts/shortcodes/page-kinds.html → .../content-management/_common/page-kinds.md
@@ -1,7 +1,17 @@
+---
+# Do not remove front matter.
+---
+
 | Kind | Description | Example |
 |----------------|--------------------------------------------------------------------|-------------------------------------------------------------------------------|
 | `home` | The landing page for the home page | `/index.html` |
 | `page` | The landing page for a given page | `my-post` page (`/posts/my-post/index.html`) |
 | `section` | The landing page of a given section | `posts` section (`/posts/index.html`) |
 | `taxonomy` | The landing page for a taxonomy | `tags` taxonomy (`/tags/index.html`) |
 | `term` | The landing page for one taxonomy's term | term `awesome` in `tags` taxonomy (`/tags/awesome/index.html`) |
+
+Four other page kinds unrelated to content are `robotsTXT`, `RSS`, `sitemap`, and `404`. Although primarily for internal use, you can specify the name when disabling one or more page kinds on your site. For example:
+
+{{< code-toggle file=hugo >}}
+disableKinds = ['robotsTXT','404']
+{{< /code-toggle >}}
diff --git a/content/en/content-management/archetypes.md b/content/en/content-management/archetypes.md
@@ -19,21 +19,21 @@ A content file consists of [front matter] and markup. The markup is typically ma
 
 The `hugo new content` command creates a new file in the `content` directory, using an archetype as a template. This is the default archetype:
 
-{{< code-toggle file="archetypes/default.md" copy=false fm=true >}}
+{{< code-toggle file="archetypes/default.md" fm=true >}}
 title = '{{ replace .File.ContentBaseName `-` ` ` | title }}'
 date = '{{ .Date }}'
 draft = true
 {{< /code-toggle >}}
 
 When you create new content, Hugo evaluates the [template actions] within the archetype. For example:
 
-```text
+```sh
 hugo new content posts/my-first-post.md
 ```
 
 With the default archetype shown above, Hugo creates this content file:
 
-{{< code-toggle file="content/posts/my-first-post.md" copy=false fm=true >}}
+{{< code-toggle file="content/posts/my-first-post.md" fm=true >}}
 title = 'My First Post'
 date = '2023-08-24T11:49:46-07:00'
 draft = true
@@ -53,7 +53,7 @@ Hugo looks for archetypes in the `archetypes` directory in the root of your proj
 
 For example, with this command:
 
-```text
+```sh
 hugo new content posts/my-first-post.md
 ```
 
@@ -85,8 +85,7 @@ Although typically used as a front matter template, you can also use an archetyp
 
 For example, in a documentation site you might have a section (content type) for functions. Every page within this section should follow the same format: a brief description, the function signature, examples, and notes. We can pre-populate the page to remind content authors of the standard format.
 
-
-{{< code file="archetypes/functions.md" copy=false >}}
+{{< code file="archetypes/functions.md" >}}
 ---
 date: '{{ .Date }}'
 draft: true
@@ -125,17 +124,17 @@ Create an archetype for galleries:
 ```text
 archetypes/
 ├── galleries/
-│   ├── images/
-│   │   └── .gitkeep
-│   └── index.md      <-- same format as default.md
+│   ├── images/
+│   │   └── .gitkeep
+│   └── index.md      <-- same format as default.md
 └── default.md
 ```
 
 Subdirectories within an archetype must contain at least one file. Without a file, Hugo will not create the subdirectory when you create new content. The name and size of the file are irrelevant. The example above includes a&nbsp;`.gitkeep` file, an empty file commonly used to preserve otherwise empty directories in a Git repository.
 
-
 To create a new gallery:
-```text
+
+```sh
 hugo new galleries/bryce-canyon
 ```
 
@@ -166,13 +165,13 @@ archetypes/
 
 To create an article using the articles archetype:
 
-```text
+```sh
 hugo new content articles/something.md
 ```
 
 To create an article using the tutorials archetype:
 
-```text
+```sh
 hugo new content --kind tutorials articles/something.md
 ```
 

diff --git a/content/en/content-management/build-options.md b/content/en/content-management/build-options.md
@@ -51,7 +51,7 @@ If set to `true` (default) the [Bundle's Resources](/content-management/page-bun
 Setting this to `false` will still publish Resources on demand (when a resource's `.Permalink` or `.RelPermalink` is invoked from the templates) but will skip the others.
 
 {{% note %}}
-Any page, regardless of their build options, will always be available using the [`.GetPage`](/functions/getpage) methods.
+Any page, regardless of their build options, will always be available using the [`.GetPage`](/methods/page/getpage) methods.
 {{% /note %}}
 
 ### Illustrative use cases
@@ -60,14 +60,14 @@ Any page, regardless of their build options, will always be available using the
 
 Project needs a "Who We Are" content file for front matter and body to be used by the homepage but nowhere else.
 
-{{< code-toggle file="content/who-we-are.md" fm=true copy=false >}}
+{{< code-toggle file="content/who-we-are.md" fm=true >}}
 title: Who we are
 _build:
  list: false
  render: false
 {{< /code-toggle >}}
 
-{{< code file="layouts/index.html" copy=false >}}
+{{< code file="layouts/index.html" >}}
 <section id="who-we-are">
   {{ with site.GetPage "who-we-are" }}
     {{ .Content }}
@@ -91,7 +91,7 @@ cascade:
     list: true # default
 {{< /code-toggle >}}
 
-{{< code file="layouts/_defaults/testimonials.html" copy=false >}}
+{{< code file="layouts/_defaults/testimonials.html" >}}
 <section id="testimonials">
   {{ range first 5 .Pages }}
     <blockquote cite="{{ .Params.cite }}">

diff --git a/content/en/content-management/comments.md b/content/en/content-management/comments.md
@@ -24,7 +24,7 @@ Hugo comes with all the code you need to load Disqus into your templates. Before
 
 Disqus comments require you set a single value in your [site's configuration file][configuration] like so:
 
-{{< code-toggle copy=false >}}
+{{< code-toggle file=hugo >}}
 disqusShortname = "yourDisqusShortname"
 {{</ code-toggle >}}
 

diff --git a/content/en/content-management/cross-references.md b/content/en/content-management/cross-references.md
@@ -35,7 +35,6 @@ The `ref` and `relref` shortcodes require a single parameter: the path to a cont
 
 The pages can be referenced as follows:
 
-
 ```text
 {{</* ref "document2" */>}}             // <- From pages/document1.md, relative path
 {{</* ref "document2#anchor" */>}}      
@@ -138,15 +137,14 @@ produces this HTML:
 
 ## Ref and RelRef Configuration
 
-The behavior can, since Hugo 0.45, be configured in `hugo.toml`:
+The behavior can be configured in `hugo.toml`:
 
 refLinksErrorLevel ("ERROR")
 : When using `ref` or `relref` to resolve page links and a link cannot resolved, it will be logged with this log level. Valid values are `ERROR` (default) or `WARNING`. Any `ERROR` will fail the build (`exit -1`).
 
 refLinksNotFoundURL
 : URL to be used as a placeholder when a page reference cannot be found in `ref` or `relref`. Is used as-is.
 
-
 [lists]: /templates/lists/
 [output formats]: /templates/output-formats/
 [shortcode]: /content-management/shortcodes/
diff --git a/content/en/content-management/diagrams.md b/content/en/content-management/diagrams.md
@@ -165,7 +165,6 @@ Created from <https://arthursonzogni.com/Diagon/#Tree>
          └─Fedora
 ```
 
-
 ### Sequence diagram
 
 <https://arthursonzogni.com/Diagon/#Sequence>
@@ -186,7 +185,6 @@ Created from <https://arthursonzogni.com/Diagon/#Tree>
 
 ```
 
-
 ### Flowchart
 
 <https://arthursonzogni.com/Diagon/#Flowchart>
@@ -232,7 +230,6 @@ Created from <https://arthursonzogni.com/Diagon/#Tree>
 
 ```
 
-
 ### Table
 
 <https://arthursonzogni.com/Diagon/#Table>