summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2022-03-08 19:37:17 +0100
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2022-03-08 19:37:17 +0100
commitd706529720b3b2ccb99719ccd578062ca25a0cc2 (patch)
tree08e0bda30f54a7e363697b21b8aa53f6d6778adb
parentc1398b91a9f4c67876b31feb67516b252e654d3c (diff)
Squashed 'docs/' changes from 3f95a2ace..a393f4cf4
a393f4cf4 Add a Spellcheck GitHub Action and config 8b6b1c381 netlify: Bump to Hugo 0.93.3 84515c183 Delete deployment-with-nanobox.md dd45f9899 Fix typos in docs e69de81a9 Update build-options.md 7745b7891 netlify: Hubo 0.93.2 037d63364 Clarify GitHub Pages Branches 94660c34b add missing %s 325de15e2 fix link to latest release note since the release notes were moved to GitHub: https://gohugo.io/news/no-more-releasenotes-here/ dbff41d01 Update introduction.md 0ecd627f7 netlify: Hugo 0.93.1 a74e16582 Update diagrams.md 33e310956 Add Goat example to test styling fa0100a5b Update diagrams.md 64ac75367 Adjust diagram docs f1d600044 Update theme 95bedff1a netlify: Bump to Hugo 0.93.0 849a8437f Merge commit 'c1398b91a9f4c67876b31feb67516b252e654d3c' c0c60c43c docs: Regenerate docs helper 2c63fe518 cod: Regen CLI docs f33ba4e5a CodeblockContext method renames 979b47968 Move the Goat template to the correct place 2df37e9e8 Add Markdown diagrams and render hooks for code blocks bd8037d43 Allow images to be cropped without being resized 8b2af4b49 modules: Add modules.Workspace config for Go 1.18 46b99dea1 Add --printUnusedTemplates 1285302c9 commands: Rename --i18n-warnings to printI18nWarnings dea2242c6 commands: Rename --path-warnings, --print-men to --printPathWarnings, --printMemoryUsage db782ea46 deps: Update github.com/alecthomas/chroma v0.9.4 => v0.10.0 git-subtree-dir: docs git-subtree-split: a393f4cf43829011e96d109de2f039a9b05b2d16
-rw-r--r--.cspell.json155
-rw-r--r--.github/workflows/spellcheck.yml17
-rw-r--r--_vendor/github.com/gohugoio/gohugoioTheme/layouts/_default/baseof.html4
-rw-r--r--_vendor/github.com/gohugoio/gohugoioTheme/layouts/partials/hooks/after-body-start.html1
-rw-r--r--_vendor/github.com/gohugoio/gohugoioTheme/layouts/partials/hooks/before-body-end.html1
-rw-r--r--_vendor/github.com/gohugoio/gohugoioTheme/layouts/partials/site-nav.html2
-rw-r--r--_vendor/modules.txt2
-rw-r--r--content/en/commands/hugo.md11
-rw-r--r--content/en/commands/hugo_completion.md11
-rw-r--r--content/en/commands/hugo_completion_bash.md22
-rw-r--r--content/en/commands/hugo_completion_fish.md11
-rw-r--r--content/en/commands/hugo_completion_powershell.md8
-rw-r--r--content/en/commands/hugo_completion_zsh.md19
-rw-r--r--content/en/commands/hugo_mod.md9
-rw-r--r--content/en/commands/hugo_new.md9
-rw-r--r--content/en/commands/hugo_server.md9
-rw-r--r--content/en/content-management/build-options.md4
-rw-r--r--content/en/content-management/comments.md2
-rw-r--r--content/en/content-management/diagrams.md277
-rw-r--r--content/en/content-management/image-processing/index.md24
-rw-r--r--content/en/hosting-and-deployment/deployment-with-nanobox.md249
-rw-r--r--content/en/hosting-and-deployment/hosting-on-github.md10
-rw-r--r--content/en/hugo-modules/configuration.md4
-rwxr-xr-xcontent/en/hugo-pipes/introduction.md17
-rw-r--r--content/en/news/0.15-relnotes/index.md2
-rw-r--r--content/en/news/0.20-relnotes/index.md2
-rw-r--r--content/en/news/0.22-relnotes/index.md2
-rw-r--r--content/en/news/0.46-relnotes/index.md2
-rw-r--r--data/docs.json87
-rw-r--r--go.mod3
-rw-r--r--go.sum2
-rw-r--r--layouts/_default/_markup/render-codeblock-mermaid.html4
-rw-r--r--layouts/partials/hooks/before-body-end.html6
-rw-r--r--layouts/shortcodes/imgproc.html4
-rw-r--r--layouts/shortcodes/new-in.html4
-rw-r--r--netlify.toml8
-rw-r--r--static/img/examples/trees.svg104
37 files changed, 775 insertions, 333 deletions
diff --git a/.cspell.json b/.cspell.json
new file mode 100644
index 000000000..70811e515
--- /dev/null
+++ b/.cspell.json
@@ -0,0 +1,155 @@
+{
+ "version": "0.2",
+ "words": [
+ "aabb",
+ "aabba",
+ "aabbaa",
+ "aabbaabb",
+ "abourget",
+ "adoc",
+ "algolia",
+ "anchorize",
+ "anthonyfok",
+ "asciidoctor",
+ "attrlink",
+ "Bjørn",
+ "blackfriday",
+ "blogue",
+ "bogem",
+ "Brotli",
+ "canonify",
+ "Catwoman",
+ "Cheatsheet",
+ "chromastyles",
+ "clockoon",
+ "Cloudinary",
+ "CNAME",
+ "Codecademy's",
+ "CODEOWNERS",
+ "Commento",
+ "Cond",
+ "Contentful",
+ "countrunes",
+ "countwords",
+ "crossreferences",
+ "digitalcraftsman",
+ "Disqus",
+ "dokuwiki",
+ "DRING",
+ "Emojify",
+ "Enwrite",
+ "eparis",
+ "errorf",
+ "firstpost",
+ "Francia",
+ "freenode",
+ "funcs",
+ "funcsig",
+ "Garen",
+ "Getenv",
+ "Gohugo",
+ "gohugoio",
+ "goldenbridge",
+ "Goldmark",
+ "gomodules",
+ "GOPATH",
+ "govendor",
+ "Gowans",
+ "Grayscale",
+ "Gruber",
+ "gtag",
+ "Hokus",
+ "hugodoc",
+ "hugolang",
+ "hugoversion",
+ "Hyvor",
+ "iframes",
+ "imgproc",
+ "indice",
+ "Intelli",
+ "interdoc",
+ "IPTC",
+ "Isset",
+ "Isso",
+ "Joomla",
+ "jsonify",
+ "katex",
+ "kubernetes",
+ "lastmod",
+ "linktitle",
+ "markdownified",
+ "markdownify",
+ "mathjax",
+ "mercredi",
+ "Mittwoch",
+ "mmark",
+ "monokai",
+ "Morling",
+ "Muut",
+ "mypartials",
+ "mypost",
+ "needsexample",
+ "nobr",
+ "nocopy",
+ "Norsk",
+ "novembre",
+ "Octopress",
+ "opengraph",
+ "OWASP",
+ "Pandoc",
+ "peaceiris",
+ "Pedersen",
+ "plainify",
+ "println",
+ "publishdate",
+ "Pygments",
+ "querify",
+ "readfile",
+ "REDIR",
+ "reftext",
+ "relatedfuncs",
+ "relref",
+ "remarkjs",
+ "rgba",
+ "rlimit",
+ "safejs",
+ "Samsa",
+ "Shortcode",
+ "Shortcodes",
+ "Sindre",
+ "Smartcrop",
+ "struct",
+ "Talkyard",
+ "taxo",
+ "tbody",
+ "tdewolff",
+ "testshortcodes",
+ "thead",
+ "Thinkful",
+ "TMPDIR",
+ "tojson",
+ "Torikian",
+ "totoml",
+ "toyaml",
+ "Unmarshal",
+ "urlize",
+ "vimrc",
+ "wanghc",
+ "Wappalyzer",
+ "warnf",
+ "webp",
+ "wibble",
+ "workson",
+ "zzbbaabb"
+ ],
+ "language": "en,en-GB,en-US,de,fr",
+ "files": [
+ "**/*.md"
+ ],
+ "ignorePaths": [
+ ".cspell.json",
+ "**/node_modules/**",
+ "*.min.*"
+ ],
+ "useGitignore": true
+}
diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml
new file mode 100644
index 000000000..0129bbb27
--- /dev/null
+++ b/.github/workflows/spellcheck.yml
@@ -0,0 +1,17 @@
+name: 'Check spelling'
+on: # rebuild any PRs and main branch changes
+ push:
+ branches-ignore:
+ - "dependabot/**"
+ pull_request:
+
+jobs:
+ spellcheck:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - uses: streetsidesoftware/cspell-action@3bc52c39528d0214a947ff7f8b5c23ad3273435b
+ with:
+ inline: warning
+ strict: false
+ incremental_files_only: true
diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/_default/baseof.html b/_vendor/github.com/gohugoio/gohugoioTheme/layouts/_default/baseof.html
index 47019072c..04261a886 100644
--- a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/_default/baseof.html
+++ b/_vendor/github.com/gohugoio/gohugoioTheme/layouts/_default/baseof.html
@@ -58,6 +58,7 @@
</head>
<body class="ma0 sans-serif bg-primary-color-light{{ with getenv "HUGO_ENV" }} {{ . }}{{ end }}">
+ {{ partial "hooks/after-body-start" . }}
{{ block "nav" . }}{{ partial "site-nav.html" . }}{{ end }}
{{ block "header" . }}{{ end }}
<main role="main" class="content-with-sidebar min-vh-100 pb7 pb0-ns">
@@ -65,6 +66,9 @@
</main>
{{ block "footer" . }}{{ partialCached "site-footer.html" . }}{{ end }}
+
+ {{ partial "hooks/before-body-end" . }}
+
</body>
diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/partials/hooks/after-body-start.html b/_vendor/github.com/gohugoio/gohugoioTheme/layouts/partials/hooks/after-body-start.html
new file mode 100644
index 000000000..426abd018
--- /dev/null
+++ b/_vendor/github.com/gohugoio/gohugoioTheme/layouts/partials/hooks/after-body-start.html
@@ -0,0 +1 @@
+{{/* Deliberately empty */}}
diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/partials/hooks/before-body-end.html b/_vendor/github.com/gohugoio/gohugoioTheme/layouts/partials/hooks/before-body-end.html
new file mode 100644
index 000000000..426abd018
--- /dev/null
+++ b/_vendor/github.com/gohugoio/gohugoioTheme/layouts/partials/hooks/before-body-end.html
@@ -0,0 +1 @@
+{{/* Deliberately empty */}}
diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/partials/site-nav.html b/_vendor/github.com/gohugoio/gohugoioTheme/layouts/partials/site-nav.html
index 0266c9939..749c699e6 100644
--- a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/partials/site-nav.html
+++ b/_vendor/github.com/gohugoio/gohugoioTheme/layouts/partials/site-nav.html
@@ -8,7 +8,7 @@
HUGO
</a>
</h1>
- <ul class="list ma0 pa0 dn dib-l">
+ <ul class="list ma0 pa0 dn dib-l" role="menu">
{{ range .Site.Menus.global }}
<li class="f5 dib mr4" role="menuitem">
{{/* TODO: Create an "Global" active class to show which site one is currently at */}}
diff --git a/_vendor/modules.txt b/_vendor/modules.txt
index a0b2c4e28..b755ed7f6 100644
--- a/_vendor/modules.txt
+++ b/_vendor/modules.txt
@@ -1 +1 @@
-# github.com/gohugoio/gohugoioTheme v0.0.0-20211211134334-0fe25799bb58
+# github.com/gohugoio/gohugoioTheme v0.0.0-20220228085601-7cfbda06d135
diff --git a/content/en/commands/hugo.md b/content/en/commands/hugo.md
index 827bb89e6..df32da793 100644
--- a/content/en/commands/hugo.md
+++ b/content/en/commands/hugo.md
@@ -35,12 +35,11 @@ hugo [flags]
--debug debug output
-d, --destination string filesystem path to write files to
--disableKinds strings disable different kind of pages (home, RSS etc.)
- --enableGitInfo add Git revision, date and author info to the pages
+ --enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages
-e, --environment string build environment
--forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build
-h, --help help for hugo
- --i18n-warnings print missing translations
--ignoreCache ignores the cache directory
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-l, --layoutDir string filesystem path to layout directory
@@ -50,9 +49,11 @@ hugo [flags]
--noChmod don't sync permission mode of files
--noTimes don't sync modification time of files
--panicOnWarning panic on first WARNING log
- --path-warnings print warnings on duplicate target paths etc.
--poll string set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes
- --print-mem print memory usage to screen at intervals
+ --printI18nWarnings print missing translations
+ --printMemoryUsage print memory usage to screen at intervals
+ --printPathWarnings print warnings on duplicate target paths etc.
+ --printUnusedTemplates print warnings on unused templates.
--quiet build in quiet mode
--renderToMemory render to memory (only useful for benchmark testing)
-s, --source string filesystem path to read files relative from
@@ -68,7 +69,7 @@ hugo [flags]
### SEE ALSO
-* [hugo completion](/commands/hugo_completion/) - generate the autocompletion script for the specified shell
+* [hugo completion](/commands/hugo_completion/) - Generate the autocompletion script for the specified shell
* [hugo config](/commands/hugo_config/) - Print the site configuration
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
* [hugo deploy](/commands/hugo_deploy/) - Deploy your site to a Cloud provider.
diff --git a/content/en/commands/hugo_completion.md b/content/en/commands/hugo_completion.md
index 944021d08..c5e70cdd7 100644
--- a/content/en/commands/hugo_completion.md
+++ b/content/en/commands/hugo_completion.md
@@ -5,11 +5,10 @@ url: /commands/hugo_completion/
---
## hugo completion
-generate the autocompletion script for the specified shell
+Generate the autocompletion script for the specified shell
### Synopsis
-
Generate the autocompletion script for hugo for the specified shell.
See each sub-command's help for details on how to use the generated script.
@@ -40,8 +39,8 @@ See each sub-command's help for details on how to use the generated script.
### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
-* [hugo completion bash](/commands/hugo_completion_bash/) - generate the autocompletion script for bash
-* [hugo completion fish](/commands/hugo_completion_fish/) - generate the autocompletion script for fish
-* [hugo completion powershell](/commands/hugo_completion_powershell/) - generate the autocompletion script for powershell
-* [hugo completion zsh](/commands/hugo_completion_zsh/) - generate the autocompletion script for zsh
+* [hugo completion bash](/commands/hugo_completion_bash/) - Generate the autocompletion script for bash
+* [hugo completion fish](/commands/hugo_completion_fish/) - Generate the autocompletion script for fish
+* [hugo completion powershell](/commands/hugo_completion_powershell/) - Generate the autocompletion script for powershell
+* [hugo completion zsh](/commands/hugo_completion_zsh/) - Generate the autocompletion script for zsh
diff --git a/content/en/commands/hugo_completion_bash.md b/content/en/commands/hugo_completion_bash.md
index 4d5a69277..e83c39836 100644
--- a/content/en/commands/hugo_completion_bash.md
+++ b/content/en/commands/hugo_completion_bash.md
@@ -5,27 +5,31 @@ url: /commands/hugo_completion_bash/
---
## hugo completion bash
-generate the autocompletion script for bash
+Generate the autocompletion script for bash
### Synopsis
-
Generate the autocompletion script for the bash shell.
This script depends on the 'bash-completion' package.
If it is not installed already, you can install it via your OS's package manager.
To load completions in your current shell session:
-$ source <(hugo completion bash)
+
+ source <(hugo completion bash)
To load completions for every new session, execute once:
-Linux:
- $ hugo completion bash > /etc/bash_completion.d/hugo
-MacOS:
- $ hugo completion bash > /usr/local/etc/bash_completion.d/hugo
+
+#### Linux:
+
+ hugo completion bash > /etc/bash_completion.d/hugo
+
+#### macOS:
+
+ hugo completion bash > /usr/local/etc/bash_completion.d/hugo
You will need to start a new shell for this setup to take effect.
-
+
```
hugo completion bash
@@ -57,5 +61,5 @@ hugo completion bash
### SEE ALSO
-* [hugo completion](/commands/hugo_completion/) - generate the autocompletion script for the specified shell
+* [hugo completion](/commands/hugo_completion/) - Generate the autocompletion script for the specified shell
diff --git a/content/en/commands/hugo_completion_fish.md b/content/en/commands/hugo_completion_fish.md
index 0d2387410..07f39b4ba 100644
--- a/content/en/commands/hugo_completion_fish.md
+++ b/content/en/commands/hugo_completion_fish.md
@@ -5,18 +5,19 @@ url: /commands/hugo_completion_fish/
---
## hugo completion fish
-generate the autocompletion script for fish
+Generate the autocompletion script for fish
### Synopsis
-
Generate the autocompletion script for the fish shell.
To load completions in your current shell session:
-$ hugo completion fish | source
+
+ hugo completion fish | source
To load completions for every new session, execute once:
-$ hugo completion fish > ~/.config/fish/completions/hugo.fish
+
+ hugo completion fish > ~/.config/fish/completions/hugo.fish
You will need to start a new shell for this setup to take effect.
@@ -51,5 +52,5 @@ hugo completion fish [flags]
### SEE ALSO
-* [hugo completion](/commands/hugo_completion/) - generate the autocompletion script for the specified shell
+* [hugo completion](/commands/hugo_completion/) - Generate the autocompletion script for the specified shell
diff --git a/content/en/commands/hugo_completion_powershell.md b/content/en/commands/hugo_completion_powershell.md
index ab45bbcc7..990f522e6 100644
--- a/content/en/commands/hugo_completion_powershell.md
+++ b/content/en/commands/hugo_completion_powershell.md
@@ -5,15 +5,15 @@ url: /commands/hugo_completion_powershell/
---
## hugo completion powershell
-generate the autocompletion script for powershell
+Generate the autocompletion script for powershell
### Synopsis
-
Generate the autocompletion script for powershell.
To load completions in your current shell session:
-PS C:\> hugo completion powershell | Out-String | Invoke-Expression
+
+ hugo completion powershell | Out-String | Invoke-Expression
To load completions for every new session, add the output of the above command
to your powershell profile.
@@ -49,5 +49,5 @@ hugo completion powershell [flags]
### SEE ALSO
-* [hugo completion](/commands/hugo_completion/) - generate the autocompletion script for the specified shell
+* [hugo completion](/commands/hugo_completion/) - Generate the autocompletion script for the specified shell
diff --git a/content/en/commands/hugo_completion_zsh.md b/content/en/commands/hugo_completion_zsh.md
index 06fb7507e..7088d4d32 100644
--- a/content/en/commands/hugo_completion_zsh.md
+++ b/content/en/commands/hugo_completion_zsh.md
@@ -5,23 +5,26 @@ url: /commands/hugo_completion_zsh/
---
## hugo completion zsh
-generate the autocompletion script for zsh
+Generate the autocompletion script for zsh
### Synopsis
-
Generate the autocompletion script for the zsh shell.
If shell completion is not already enabled in your environment you will need
to enable it. You can execute the following once:
-$ echo "autoload -U compinit; compinit" >> ~/.zshrc
+ echo "autoload -U compinit; compinit" >> ~/.zshrc
To load completions for every new session, execute once:
-# Linux:
-$ hugo completion zsh > "${fpath[1]}/_hugo"
-# macOS:
-$ hugo completion zsh > /usr/local/share/zsh/site-functions/_hugo
+
+#### Linux:
+
+ hugo completion zsh > "${fpath[1]}/_hugo"
+
+#### macOS:
+
+ hugo completion zsh > /usr/local/share/zsh/site-functions/_hugo
You will need to start a new shell for this setup to take effect.
@@ -56,5 +59,5 @@ hugo completion zsh [flags]
### SEE ALSO
-* [hugo completion](/commands/hugo_completion/) - generate the autocompletion script for the specified shell
+* [hugo completion](/commands/hugo_completion/) - Generate the autocompletion script for the specified shell
diff --git a/content/en/commands/hugo_mod.md b/content/en/commands/hugo_mod.md
index 7b620cd3e..66a076322 100644
--- a/content/en/commands/hugo_mod.md
+++ b/content/en/commands/hugo_mod.md
@@ -35,20 +35,21 @@ See https://gohugo.io/hugo-modules/ for more information.
-c, --contentDir string filesystem path to content directory
-d, --destination string filesystem path to write files to
--disableKinds strings disable different kind of pages (home, RSS etc.)
- --enableGitInfo add Git revision, date and author info to the pages
+ --enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages
--forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build
-h, --help help for mod
- --i18n-warnings print missing translations
--ignoreCache ignores the cache directory
-l, --layoutDir string filesystem path to layout directory
--minify minify any supported output format (HTML, XML etc.)
--noChmod don't sync permission mode of files
--noTimes don't sync modification time of files
--panicOnWarning panic on first WARNING log
- --path-warnings print warnings on duplicate target paths etc.
--poll string set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes
- --print-mem print memory usage to screen at intervals
+ --printI18nWarnings print missing translations
+ --printMemoryUsage print memory usage to screen at intervals
+ --printPathWarnings print warnings on duplicate target paths etc.
+ --printUnusedTemplates print warnings on unused templates.
--templateMetrics display metrics about template executions
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics
-t, --theme strings themes to use (located in /themes/THEMENAME/)
diff --git a/content/en/commands/hugo_new.md b/content/en/commands/hugo_new.md
index 018cd2af8..36a841b96 100644
--- a/content/en/commands/hugo_new.md
+++ b/content/en/commands/hugo_new.md
@@ -35,11 +35,10 @@ hugo new [path] [flags]
-d, --destination string filesystem path to write files to
--disableKinds strings disable different kind of pages (home, RSS etc.)
--editor string edit new content with this editor, if provided
- --enableGitInfo add Git revision, date and author info to the pages
+ --enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages