Skip to content

Commit

Permalink
Squashed 'docs/' changes from 4dd2d64..3b1a857
Browse files Browse the repository at this point in the history
3b1a857 Update theme
b1f04fd params: Adjust the twitter handle
2c8ba02 Fix typo
4421e46 Update Where.md
5f9fec6 Update glossary.md
fb16945 collections.Where - Clarify description of "collection"
4d6d701 Update Include.md - improve return statement example
0371510 Update IncludeCached - improve return statement example
b053fa0 Improve return types
f7d6152 Describe minimum required Windows version
e97762b Update front matter in math.Sub
9e4d03a Fix data.GetJSON examples
9029ee1 Update spellcheck GitHub Action
c852fe4 Add version verification step to quick start guide
8fafca4 Correct front matter example
b412fdf Fix closing tag in notes docs
9a64d95 Add hreflang Tag to Translation Link example
2d2a821 Fix inverted examples in Permalink and RelPermalink
ff3e67e Correct spelling
3904b72 Fix documentation contribution steps enumeration
348fd3c Fix some typos in the content summaries page
a582345 Fix two links, one to bonsai.io and one to digital.gov
c369786 Fix typo
0ee3ff4 Vendor theme
6b0a9b7 Fix typo
44e4cb5 Fix typos
8150717 Update min Go version to build from source
192d14d Fix typo
e4a1894 Miscellaneous corrections
f12b7b74e netlify: Hugo 0.121.2
97dbc1e Merge branch 'tempv0.121.2'
dc1c0ae Add cache note to resources.Concat
a8d1a60 Correct return type
eca22e9 Fix front matter
7de247a Correct return type
5058bc5 collections.Seq: Specify max slice size
e24d81a Fix typo on FAQ page
ff8cf5a Correct 'related' front matter values
88b21fa Adjust deprecation handling
f7e19a2 Update terminology on shortcode templates page
01e1094 Adjust formatting
6ed2e19 tpl/math: Add math.Rand template function
b494a8d Update js.md
6d78035 Add interval description to glossary (#2378)
f9b612b Templates Lookup Order: Add missing parenthesis
741ab1b Show vendorClosest in module default config
eb8cb87 Fix Babel headings
cdcdfc8 Change project name in Codeowners example
f31fe0d Update link to image filters
9dee1ee Update Solus installation instructions
716636f Add TOC to collections.Sort
f7c6414 Update collections.Sort
4b8f6b9 Add id attributes to Scratch and Store methods
2a1adea Add id attributes to GitInfo, File, and Resources methods
b12d9cb Add Alpine Linux installation instructions
dfbebee Change writeStats to buildStats
175b8aa resources/images: Create AutoOrient image filter
ba8e05c Update img shortcode
7fc15a6 Fix default value of  pluralizeListTitles
a0be4fd Add Comentario to available comment engines
71aa7d8 Update GitInfo.md
3484414 EXIF: describe applicable image types
743497e Disable TOC for lang.Translate
b3b1df7 Describe lang.Translate fallback behavior
a6d9c36 Categorize CLI commands to improve search results
08cc2da Document canonical config for enabling inline shortcodes
8945be9 Update description of the humanize ordinal conversion
b8b4ccb Fix grammatical error
f53f9f9 Fix description of strings.HasSuffix
cdbe19b Update Params.md
e00c4ee Reformat site config descriptions
6f50c07 Enumerate root configuration keys
1f2e7b9 Use canonical key when documenting menu configs
7d5a13d Update images.Text filter
315d2f8 Add math.Counter example to warnf
8ed9cda Miscellaneous edits
2bda491 Fix front matter example
5c5bbbe netlify: Bump to Hugo 0.121.1
ed08f59 Update Gentoo installation instructions
e4eb484 Miscellaneous edits
8c3700d netlify: Bump to Hugo 0.121.0
1bb5a37 Merge branch 'tempv0.121.0'
8cba895 Improve where function
0dfc00b docs: Regen docshelper
028076a Fix link to Gentoo package
52d2db4 Fix typo
120025c Improve Gentooo installation instructions
0c31a4b Update GitHub hosting workflow example
dee99c3 Defend against missing aliases in quick-reference shortcode
d305278 Add Gentoo installation instructions
be98a37 docs: Adjust last merge from docs repository
a703dab docs: Regen docs helper
2e9c353 Merge commit '35dec7c96f7ee3eb17dd444f7067f0c776fb56ae'
f57fdb4 deps: Update github.com/tdewolff/minify/v2 v2.20.7 => v2.20.8
50cad5e tpl/transform: Add transform.XMLEscape template function

git-subtree-dir: docs
git-subtree-split: 3b1a857
  • Loading branch information
bep committed Jan 26, 2024
1 parent 35dec7c commit 7125ad4
Show file tree
Hide file tree
Showing 143 changed files with 1,087 additions and 807 deletions.
5 changes: 4 additions & 1 deletion .cspell.json
Expand Up @@ -7,8 +7,10 @@
"flagWords": [
"alot",
"hte",
"langauge",
"reccommend",
"seperate"
"seperate",
"teh"
],
"ignorePaths": [
"**/emojis.md",
Expand Down Expand Up @@ -69,6 +71,7 @@
"transpile",
"transpiles",
"unmarshal",
"unmarshals",
"unmarshaling",
"# ----------------------------------------------------------------------",
"# cspell: ignore foreign language words",
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/spellcheck.yml
Expand Up @@ -13,7 +13,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: streetsidesoftware/cspell-action@v4
- uses: streetsidesoftware/cspell-action@v5
with:
check_dot_files: false
files: content/**/*.md
Expand Down
1 change: 1 addition & 0 deletions .markdownlint.yaml
@@ -1,5 +1,6 @@
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md

MD001: false
MD002: false
MD003: false
MD004: false
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion _vendor/modules.txt
@@ -1 +1 @@
# github.com/gohugoio/gohugoioTheme v0.0.0-20231111235806-77931ac4875e
# github.com/gohugoio/gohugoioTheme v0.0.0-20240125093153-bea12fdc0b15
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions config/_default/params.toml
Expand Up @@ -21,7 +21,7 @@ flex_box_interior_classes = "flex-auto w-100 w-40-l mr3 mb3 bg-white ba b--moon-
#sidebar_direction = "sidebar_left"

[social]
twitter = "GoHugoIO"
twitter = "GoHugoIOv2"

[render_hooks.link]
errorLevel = 'warning' # ignore (default), warning, or error (fails the build)
errorLevel = 'warning' # ignore (default), warning, or error (fails the build)
4 changes: 3 additions & 1 deletion content/en/content-management/comments.md
Expand Up @@ -25,7 +25,8 @@ 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 file=hugo >}}
disqusShortname = "yourDisqusShortname"
[services.disqus]
shortname = 'your-disqus-shortname'
{{</ code-toggle >}}

For many websites, this is enough configuration. However, you also have the option to set the following in the [front matter] of a single content file:
Expand All @@ -47,6 +48,7 @@ Disqus has its own [internal template](/templates/internal/#disqus) available, t
These are some alternatives to Disqus:

* [Cactus Comments](https://cactus.chat/docs/integrations/hugo/) (Open Source, Matrix appservice, Docker install)
* [Comentario](https://gitlab.com/comentario/comentario) (Open Source, self-hosted, Go/Angular, run locally, in Docker or Kubernetes)
* [Commento](https://commento.io/) (Open Source, available as a service, local install, or docker image)
* [Giscus](https://giscus.app/) (Open source, comments system powered by GitHub Discussions)
* [Graph Comment](https://graphcomment.com/)
Expand Down
2 changes: 1 addition & 1 deletion content/en/content-management/image-processing/index.md
Expand Up @@ -505,7 +505,7 @@ hugo --gc
[mounted]: /hugo-modules/configuration#module-configuration-mounts
[page bundle]: /content-management/page-bundles
[`lang.FormatNumber`]: /functions/lang/formatnumber
[filters]: /functions/images
[filters]: /functions/images/filter/#image-filters
[github.com/disintegration/imaging]: <https://github.com/disintegration/imaging#image-resizing>
[Smartcrop]: <https://github.com/muesli/smartcrop#smartcrop>
[Exif]: <https://en.wikipedia.org/wiki/Exif>
Expand Down
38 changes: 23 additions & 15 deletions content/en/content-management/menus.md
Expand Up @@ -48,7 +48,7 @@ To add a page to the "main" menu:

{{< code-toggle file=content/about.md fm=true >}}
title = 'About'
menu = 'main'
menus = 'main'
{{< /code-toggle >}}

Access the entry with `site.Menus.main` in your templates. See [menu templates] for details.
Expand All @@ -57,11 +57,15 @@ To add a page to the "main" and "footer" menus:

{{< code-toggle file=content/contact.md fm=true >}}
title = 'Contact'
menu = ['main','footer']
menus = ['main','footer']
{{< /code-toggle >}}

Access the entry with `site.Menus.main` and `site.Menus.footer` in your templates. See [menu templates] for details.

{{% note %}}
The configuration key in the examples above is `menus`. The `menu` (singular) configuration key is an alias for `menus`.
{{% /note %}}

### Properties {#properties-front-matter}

Use these properties when defining menu entries in front matter:
Expand Down Expand Up @@ -96,11 +100,11 @@ This front matter menu entry demonstrates some of the available properties:

{{< code-toggle file=content/products/software.md fm=true >}}
title = 'Software'
[menu.main]
[[menus.main]]
parent = 'Products'
weight = 20
pre = '<i class="fa-solid fa-code"></i>'
[menu.main.params]
[menus.main.params]
class = 'center'
{{< /code-toggle >}}

Expand All @@ -111,17 +115,17 @@ Access the entry with `site.Menus.main` in your templates. See [menu templates]
To define entries for the "main" menu:

{{< code-toggle file=hugo >}}
[[menu.main]]
[[menus.main]]
name = 'Home'
pageRef = '/'
weight = 10

[[menu.main]]
[[menus.main]]
name = 'Products'
pageRef = '/products'
weight = 20

[[menu.main]]
[[menus.main]]
name = 'Services'
pageRef = '/services'
weight = 30
Expand All @@ -132,19 +136,23 @@ This creates a menu structure that you can access with `site.Menus.main` in your
To define entries for the "footer" menu:

{{< code-toggle file=hugo >}}
[[menu.footer]]
[[menus.footer]]
name = 'Terms'
pageRef = '/terms'
weight = 10

[[menu.footer]]
[[menus.footer]]
name = 'Privacy'
pageRef = '/privacy'
weight = 20
{{< /code-toggle >}}

This creates a menu structure that you can access with `site.Menus.footer` in your templates. See [menu templates] for details.

{{% note %}}
The configuration key in the examples above is `menus`. The `menu` (singular) configuration key is an alias for `menus`.
{{% /note %}}

### Properties {#properties-site-configuration}

{{% note %}}
Expand Down Expand Up @@ -177,34 +185,34 @@ url
This nested menu demonstrates some of the available properties:

{{< code-toggle file=hugo >}}
[[menu.main]]
[[menus.main]]
name = 'Products'
pageRef = '/products'
weight = 10

[[menu.main]]
[[menus.main]]
name = 'Hardware'
pageRef = '/products/hardware'
parent = 'Products'
weight = 1

[[menu.main]]
[[menus.main]]
name = 'Software'
pageRef = '/products/software'
parent = 'Products'
weight = 2

[[menu.main]]
[[menus.main]]
name = 'Services'
pageRef = '/services'
weight = 20

[[menu.main]]
[[menus.main]]
name = 'Hugo'
pre = '<i class="fa fa-heart"></i>'
url = 'https://gohugo.io/'
weight = 30
[menu.main.params]
[menus.main.params]
rel = 'external'
{{< /code-toggle >}}

Expand Down

0 comments on commit 7125ad4

Please sign in to comment.