Skip to content

Commit

Permalink
Squashed 'docs/' changes from 39af43ef1..1798dc0d5
Browse files Browse the repository at this point in the history
1798dc0d5 Update theme
403fa716e Update CLI documentation (#2092)
aade5a09e Correct media subtype example
53cd9dea6 netlify: Hugo 0.112.3
b78b86cb1 Add source/target warning to resources.Copy (#2091)
50c299729 netlify: Hugo 0.112.2
73197046f Change config.xxx to hugo.xxx throughout the documentation (#2090)
d489d4c6f Add hugo.WorkingDir to docs (#2089)
7487df809 Fix typos (#2088)
6d0572cd6 netlify: Hugo 0.112.1
6838600b2 netlify: Hugo 0.112.0
513e7a80f Merge branch 'tempv0.112.0'
91eb44275 Some more about 0.112.0
bd3b33a27 docs: Regen docshelper
fb3027daf docs: Regen CLI docs
8e7b8e987 Merge commit 'f96384a3b596f9bc0a3a035970b09b2c601f0ccb'
a942ceef4 tpl/tplimpl: Add img loading attribute to figure shortcode  (#10927)
0e0c7b25e tpl/urls: Return empty string when JoinPath has zero args
310ce949a tpl/urls: Add JoinPath template function
ae435ca77 tpl: Add math.Abs
f340139f8 Revert "Update syntax-highlighting.md (#10929)" (#10930)
917a0e24d Update syntax-highlighting.md (#10929)

git-subtree-dir: docs
git-subtree-split: 1798dc0d54ce048dd975863b490cd809ef14268a
  • Loading branch information
bep committed May 27, 2023
1 parent f96384a commit d392731
Show file tree
Hide file tree
Showing 90 changed files with 928 additions and 682 deletions.

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
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# github.com/gohugoio/gohugoioTheme v0.0.0-20230418063032-99f9185b8e11
# github.com/gohugoio/gohugoioTheme v0.0.0-20230527124826-78bc315d7b8a
10 changes: 5 additions & 5 deletions content/en/about/hugo-and-gdpr.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ toc: true

## All Privacy Settings

Below are all privacy settings and their default value. These settings need to be put in your site config (e.g. `config.toml`).
Below are all privacy settings and their default value. These settings need to be put in your site config (e.g. `hugo.toml`).

{{< code-toggle file="config">}}
{{< code-toggle file="hugo" >}}
[privacy]
[privacy.disqus]
disable = false
Expand Down Expand Up @@ -58,7 +58,7 @@ privacyEnhanced = false

An example Privacy Config that disables all the relevant services in Hugo. With this configuration, the other settings will not matter.

{{< code-toggle file="config">}}
{{< code-toggle file="hugo" >}}
[privacy]
[privacy.disqus]
disable = true
Expand Down Expand Up @@ -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="config">}}
{{< code-toggle file="hugo" >}}
[services]
[services.instagram]
disableInlineCSS = true
Expand All @@ -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="config">}}
{{< code-toggle file="hugo" >}}
[services]
[services.twitter]
disableInlineCSS = true
Expand Down
3 changes: 2 additions & 1 deletion content/en/commands/hugo.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ hugo [flags]
--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.
--format string preferred file format (toml, yaml or json) (default "toml")
--gc enable to run some cleanup tasks (remove unused cache files) after the build
-h, --help help for hugo
--ignoreCache ignores the cache directory
Expand Down Expand Up @@ -82,5 +83,5 @@ hugo [flags]
* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers.
* [hugo new](/commands/hugo_new/) - Create new content for your site
* [hugo server](/commands/hugo_server/) - A high performance webserver
* [hugo version](/commands/hugo_version/) - Print the version number of Hugo
* [hugo version](/commands/hugo_version/) - Print Hugo version and environment info

2 changes: 2 additions & 0 deletions content/en/commands/hugo_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ See each sub-command's help for details on how to use the generated script.
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
Expand Down
2 changes: 2 additions & 0 deletions content/en/commands/hugo_completion_bash.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,9 @@ hugo completion bash
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
Expand Down
2 changes: 2 additions & 0 deletions content/en/commands/hugo_completion_fish.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,9 @@ hugo completion fish [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
Expand Down
2 changes: 2 additions & 0 deletions content/en/commands/hugo_completion_powershell.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ hugo completion powershell [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
Expand Down
4 changes: 3 additions & 1 deletion content/en/commands/hugo_completion_zsh.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ to enable it. You can execute the following once:

To load completions in your current shell session:

source <(hugo completion zsh); compdef _hugo hugo
source <(hugo completion zsh)

To load completions for every new session, execute once:

Expand Down Expand Up @@ -51,7 +51,9 @@ hugo completion zsh [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
Expand Down
32 changes: 17 additions & 15 deletions content/en/commands/hugo_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,31 +12,33 @@ Print the site configuration
Print the site configuration, both default and custom settings.

```
hugo config [flags]
hugo config [command] [flags]
```

### Options

```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-e, --environment string build environment
-h, --help help for config
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-h, --help help for config
```

### Options inherited from parent commands

```
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-v, --verbose verbose output
--verboseLog verbose logging
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
```

### SEE ALSO
Expand Down
4 changes: 3 additions & 1 deletion content/en/commands/hugo_config_mounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ url: /commands/hugo_config_mounts/
Print the configured file mounts

```
hugo config mounts [flags]
hugo config mounts [flags] [args]
```

### Options
Expand All @@ -24,7 +24,9 @@ hugo config mounts [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
Expand Down
38 changes: 22 additions & 16 deletions content/en/commands/hugo_convert.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,30 +13,36 @@ Convert your content (e.g. front matter) to different formats.

See convert's subcommands toJSON, toTOML and toYAML for more information.

```
hugo convert [command] [flags]
```

### Options

```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-e, --environment string build environment
-h, --help help for convert
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-o, --output string filesystem path to write files to
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
--unsafe enable less safe operations, please backup first
-h, --help help for convert
-o, --output string filesystem path to write files to
--unsafe enable less safe operations, please backup first
```

### Options inherited from parent commands

```
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-v, --verbose verbose output
--verboseLog verbose logging
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
```

### SEE ALSO
Expand Down
4 changes: 3 additions & 1 deletion content/en/commands/hugo_convert_toJSON.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ toJSON converts all front matter in the content directory
to use JSON for the front matter.

```
hugo convert toJSON [flags]
hugo convert toJSON [flags] [args]
```

### Options
Expand All @@ -29,7 +29,9 @@ hugo convert toJSON [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
Expand Down
4 changes: 3 additions & 1 deletion content/en/commands/hugo_convert_toTOML.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ toTOML converts all front matter in the content directory
to use TOML for the front matter.

```
hugo convert toTOML [flags]
hugo convert toTOML [flags] [args]
```

### Options
Expand All @@ -29,7 +29,9 @@ hugo convert toTOML [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
Expand Down
4 changes: 3 additions & 1 deletion content/en/commands/hugo_convert_toYAML.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ toYAML converts all front matter in the content directory
to use YAML for the front matter.

```
hugo convert toYAML [flags]
hugo convert toYAML [flags] [args]
```

### Options
Expand All @@ -29,7 +29,9 @@ hugo convert toYAML [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
Expand Down
46 changes: 24 additions & 22 deletions content/en/commands/hugo_deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,38 +16,40 @@ documentation.


```
hugo deploy [flags]
hugo deploy [flags] [args]
```

### Options

```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--confirm ask for confirmation before making changes to the target
--dryRun dry run
-e, --environment string build environment
--force force upload of all files
-h, --help help for deploy
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--invalidateCDN invalidate the CDN cache listed in the deployment target (default true)
--maxDeletes int maximum # of files to delete, or -1 to disable (default 256)
--workers int number of workers to transfer files. (default 10)
-s, --source string filesystem path to read files relative from
--target string target deployment from deployments section in config file; defaults to the first one
--themesDir string filesystem path to themes directory
--confirm ask for confirmation before making changes to the target
--dryRun dry run
--force force upload of all files
-h, --help help for deploy
--invalidateCDN invalidate the CDN cache listed in the deployment target (default true)
--maxDeletes int maximum # of files to delete, or -1 to disable (default 256)
--target string target deployment from deployments section in config file; defaults to the first one
--workers int number of workers to transfer files. defaults to 10 (default 10)
```

### Options inherited from parent commands

```
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-v, --verbose verbose output
--verboseLog verbose logging
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
```

### SEE ALSO
Expand Down
9 changes: 4 additions & 5 deletions content/en/commands/hugo_env.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,10 @@ Print Hugo version and environment info

### Synopsis

Print Hugo version and environment info. This is useful in Hugo bug reports.

If you add the -v flag, you will get a full dependency list.

Print Hugo version and environment info. This is useful in Hugo bug reports

```
hugo env [flags]
hugo env [flags] [args]
```

### Options
Expand All @@ -31,7 +28,9 @@ hugo env [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
Expand Down
Loading

0 comments on commit d392731

Please sign in to comment.