Skip to content

Commit

Permalink
Squashed 'docs/' changes from d343ebf..bb15e98
Browse files Browse the repository at this point in the history
bb15e98 Update index.md (#1339)
ffb2f21 Update index.md
fc154ac Regenerate CLI docs
a0a6877 Update index.md
d0e35a8 Update index.md
86d0cc0 Update index.md
bdaf7e0 Release 0.81.0
b510174 releaser: Add release notes to /docs for release of 0.81.0
888dd8f docs: Regen CLI docs
8c3e8b2 docs: Regen docs helper
79e3e1e Merge commit 'acb9109df778fa4a51c0d8b29b3212b12988908f'
31f70af modules: Add config option modules.vendorClosest
2631df9 markup/goldmark: Add attributes support for blocks (tables etc.)
19dee04 Update to Dart Sass Protocol beta6
e507721 Refactor: Write to stdout by default
d204bf1 Refactor: Remove powershell support
91bea48 Feat: Add zsh, fish and powershell completion support
9c915ea docs: Remove mention of a file size limit for readFile
5acc8b6 js: Add Inject config option
4532198 js: Add Shims option

git-subtree-dir: docs
git-subtree-split: bb15e98
  • Loading branch information
bep committed Feb 23, 2021
1 parent acb9109 commit 9d31f65
Show file tree
Hide file tree
Showing 59 changed files with 463 additions and 150 deletions.
20 changes: 20 additions & 0 deletions config/_default/markup.toml
@@ -1,5 +1,25 @@
defaultMarkdownHandler = "goldmark"

[goldmark]
[goldmark.extensions]
definitionList = true
footnote = true
linkify = true
strikethrough = true
table = true
taskList = true
typographer = true
[goldmark.parser]
autoHeadingID = true
autoHeadingIDType = "github"
[goldmark.parser.attribute]
block = true
title = true
[goldmark.renderer]
hardWraps = false
unsafe = false
xhtml = false

[highlight]
style = "trac"
lineNumbersInTable = true
Expand Down
4 changes: 2 additions & 2 deletions content/en/commands/hugo.md
@@ -1,5 +1,5 @@
---
date: 2020-09-13
date: 2021-02-20
title: "hugo"
slug: hugo
url: /commands/hugo/
Expand Down Expand Up @@ -81,4 +81,4 @@ hugo [flags]
* [hugo server](/commands/hugo_server/) - A high performance webserver
* [hugo version](/commands/hugo_version/) - Print the version number of Hugo

###### Auto generated by spf13/cobra on 13-Sep-2020
###### Auto generated by spf13/cobra on 20-Feb-2021
8 changes: 2 additions & 6 deletions content/en/commands/hugo_check.md
@@ -1,5 +1,5 @@
---
date: 2020-09-13
date: 2021-02-20
title: "hugo check"
slug: hugo_check
url: /commands/hugo_check/
Expand All @@ -8,10 +8,6 @@ url: /commands/hugo_check/

Contains some verification checks

### Synopsis

Contains some verification checks

### Options

```
Expand Down Expand Up @@ -41,4 +37,4 @@ Contains some verification checks
* [hugo](/commands/hugo/) - hugo builds your site
* [hugo check ulimit](/commands/hugo_check_ulimit/) - Check system ulimit settings

###### Auto generated by spf13/cobra on 13-Sep-2020
###### Auto generated by spf13/cobra on 20-Feb-2021
4 changes: 2 additions & 2 deletions content/en/commands/hugo_check_ulimit.md
@@ -1,5 +1,5 @@
---
date: 2020-09-13
date: 2021-02-20
title: "hugo check ulimit"
slug: hugo_check_ulimit
url: /commands/hugo_check_ulimit/
Expand Down Expand Up @@ -45,4 +45,4 @@ hugo check ulimit [flags]

* [hugo check](/commands/hugo_check/) - Contains some verification checks

###### Auto generated by spf13/cobra on 13-Sep-2020
###### Auto generated by spf13/cobra on 20-Feb-2021
4 changes: 2 additions & 2 deletions content/en/commands/hugo_config.md
@@ -1,5 +1,5 @@
---
date: 2020-09-13
date: 2021-02-20
title: "hugo config"
slug: hugo_config
url: /commands/hugo_config/
Expand Down Expand Up @@ -45,4 +45,4 @@ hugo config [flags]
* [hugo](/commands/hugo/) - hugo builds your site
* [hugo config mounts](/commands/hugo_config_mounts/) - Print the configured file mounts

###### Auto generated by spf13/cobra on 13-Sep-2020
###### Auto generated by spf13/cobra on 20-Feb-2021
8 changes: 2 additions & 6 deletions content/en/commands/hugo_config_mounts.md
@@ -1,5 +1,5 @@
---
date: 2020-09-13
date: 2021-02-20
title: "hugo config mounts"
slug: hugo_config_mounts
url: /commands/hugo_config_mounts/
Expand All @@ -8,10 +8,6 @@ url: /commands/hugo_config_mounts/

Print the configured file mounts

### Synopsis

Print the configured file mounts

```
hugo config mounts [flags]
```
Expand Down Expand Up @@ -44,4 +40,4 @@ hugo config mounts [flags]

* [hugo config](/commands/hugo_config/) - Print the site configuration

###### Auto generated by spf13/cobra on 13-Sep-2020
###### Auto generated by spf13/cobra on 20-Feb-2021
4 changes: 2 additions & 2 deletions content/en/commands/hugo_convert.md
@@ -1,5 +1,5 @@
---
date: 2020-09-13
date: 2021-02-20
title: "hugo convert"
slug: hugo_convert
url: /commands/hugo_convert/
Expand Down Expand Up @@ -47,4 +47,4 @@ See convert's subcommands toJSON, toTOML and toYAML for more information.
* [hugo convert toTOML](/commands/hugo_convert_totoml/) - Convert front matter to TOML
* [hugo convert toYAML](/commands/hugo_convert_toyaml/) - Convert front matter to YAML

###### Auto generated by spf13/cobra on 13-Sep-2020
###### Auto generated by spf13/cobra on 20-Feb-2021
4 changes: 2 additions & 2 deletions content/en/commands/hugo_convert_toJSON.md
@@ -1,5 +1,5 @@
---
date: 2020-09-13
date: 2021-02-20
title: "hugo convert toJSON"
slug: hugo_convert_toJSON
url: /commands/hugo_convert_tojson/
Expand Down Expand Up @@ -47,4 +47,4 @@ hugo convert toJSON [flags]

* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats

###### Auto generated by spf13/cobra on 13-Sep-2020
###### Auto generated by spf13/cobra on 20-Feb-2021
4 changes: 2 additions & 2 deletions content/en/commands/hugo_convert_toTOML.md
@@ -1,5 +1,5 @@
---
date: 2020-09-13
date: 2021-02-20
title: "hugo convert toTOML"
slug: hugo_convert_toTOML
url: /commands/hugo_convert_totoml/
Expand Down Expand Up @@ -47,4 +47,4 @@ hugo convert toTOML [flags]

* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats

###### Auto generated by spf13/cobra on 13-Sep-2020
###### Auto generated by spf13/cobra on 20-Feb-2021
4 changes: 2 additions & 2 deletions content/en/commands/hugo_convert_toYAML.md
@@ -1,5 +1,5 @@
---
date: 2020-09-13
date: 2021-02-20
title: "hugo convert toYAML"
slug: hugo_convert_toYAML
url: /commands/hugo_convert_toyaml/
Expand Down Expand Up @@ -47,4 +47,4 @@ hugo convert toYAML [flags]

* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats

###### Auto generated by spf13/cobra on 13-Sep-2020
###### Auto generated by spf13/cobra on 20-Feb-2021
4 changes: 2 additions & 2 deletions content/en/commands/hugo_deploy.md
@@ -1,5 +1,5 @@
---
date: 2020-09-13
date: 2021-02-20
title: "hugo deploy"
slug: hugo_deploy
url: /commands/hugo_deploy/
Expand Down Expand Up @@ -54,4 +54,4 @@ hugo deploy [flags]

* [hugo](/commands/hugo/) - hugo builds your site

###### Auto generated by spf13/cobra on 13-Sep-2020
###### Auto generated by spf13/cobra on 20-Feb-2021
4 changes: 2 additions & 2 deletions content/en/commands/hugo_env.md
@@ -1,5 +1,5 @@
---
date: 2020-09-13
date: 2021-02-20
title: "hugo env"
slug: hugo_env
url: /commands/hugo_env/
Expand Down Expand Up @@ -44,4 +44,4 @@ hugo env [flags]

* [hugo](/commands/hugo/) - hugo builds your site

###### Auto generated by spf13/cobra on 13-Sep-2020
###### Auto generated by spf13/cobra on 20-Feb-2021
8 changes: 2 additions & 6 deletions content/en/commands/hugo_gen.md
@@ -1,5 +1,5 @@
---
date: 2020-09-13
date: 2021-02-20
title: "hugo gen"
slug: hugo_gen
url: /commands/hugo_gen/
Expand All @@ -8,10 +8,6 @@ url: /commands/hugo_gen/

A collection of several useful generators.

### Synopsis

A collection of several useful generators.

### Options

```
Expand Down Expand Up @@ -44,4 +40,4 @@ A collection of several useful generators.
* [hugo gen doc](/commands/hugo_gen_doc/) - Generate Markdown documentation for the Hugo CLI.
* [hugo gen man](/commands/hugo_gen_man/) - Generate man pages for the Hugo CLI

###### Auto generated by spf13/cobra on 13-Sep-2020
###### Auto generated by spf13/cobra on 20-Feb-2021
22 changes: 9 additions & 13 deletions content/en/commands/hugo_gen_autocomplete.md
@@ -1,5 +1,5 @@
---
date: 2020-09-13
date: 2021-02-20
title: "hugo gen autocomplete"
slug: hugo_gen_autocomplete
url: /commands/hugo_gen_autocomplete/
Expand All @@ -12,21 +12,17 @@ Generate shell autocompletion script for Hugo

Generates a shell autocompletion script for Hugo.

NOTE: The current version supports Bash only.
This should work for *nix systems with Bash installed.
The script is written to the console (stdout).

By default, the file is written directly to /etc/bash_completion.d
for convenience, and the command may need superuser rights, e.g.:
To write to file, add the `--completionfile=/path/to/file` flag.

$ sudo hugo gen autocomplete

Add `--completionfile=/path/to/file` flag to set alternative
file-path and name.
Add `--type={bash, zsh, fish or powershell}` flag to set alternative
shell type.

Logout and in again to reload the completion scripts,
or just source them in directly:

$ . /etc/bash_completion
$ . /etc/bash_completion or /path/to/file

```
hugo gen autocomplete [flags]
Expand All @@ -35,9 +31,9 @@ hugo gen autocomplete [flags]
### Options

```
--completionfile string autocompletion file (default "/etc/bash_completion.d/hugo.sh")
-f, --completionfile string autocompletion file, defaults to stdout
-h, --help help for autocomplete
--type string autocompletion type (currently only bash supported) (default "bash")
-t, --type string autocompletion type (bash, zsh, fish, or powershell) (default "bash")
```

### Options inherited from parent commands
Expand All @@ -62,4 +58,4 @@ hugo gen autocomplete [flags]

* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.

###### Auto generated by spf13/cobra on 13-Sep-2020
###### Auto generated by spf13/cobra on 20-Feb-2021
4 changes: 2 additions & 2 deletions content/en/commands/hugo_gen_chromastyles.md
@@ -1,5 +1,5 @@
---
date: 2020-09-13
date: 2021-02-20
title: "hugo gen chromastyles"
slug: hugo_gen_chromastyles
url: /commands/hugo_gen_chromastyles/
Expand Down Expand Up @@ -49,4 +49,4 @@ hugo gen chromastyles [flags]

* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.

###### Auto generated by spf13/cobra on 13-Sep-2020
###### Auto generated by spf13/cobra on 20-Feb-2021
4 changes: 2 additions & 2 deletions content/en/commands/hugo_gen_doc.md
@@ -1,5 +1,5 @@
---
date: 2020-09-13
date: 2021-02-20
title: "hugo gen doc"
slug: hugo_gen_doc
url: /commands/hugo_gen_doc/
Expand Down Expand Up @@ -51,4 +51,4 @@ hugo gen doc [flags]

* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.

###### Auto generated by spf13/cobra on 13-Sep-2020
###### Auto generated by spf13/cobra on 20-Feb-2021
4 changes: 2 additions & 2 deletions content/en/commands/hugo_gen_man.md
@@ -1,5 +1,5 @@
---
date: 2020-09-13
date: 2021-02-20
title: "hugo gen man"
slug: hugo_gen_man
url: /commands/hugo_gen_man/
Expand Down Expand Up @@ -47,4 +47,4 @@ hugo gen man [flags]

* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.

###### Auto generated by spf13/cobra on 13-Sep-2020
###### Auto generated by spf13/cobra on 20-Feb-2021
4 changes: 2 additions & 2 deletions content/en/commands/hugo_import.md
@@ -1,5 +1,5 @@
---
date: 2020-09-13
date: 2021-02-20
title: "hugo import"
slug: hugo_import
url: /commands/hugo_import/
Expand Down Expand Up @@ -43,4 +43,4 @@ Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_p
* [hugo](/commands/hugo/) - hugo builds your site
* [hugo import jekyll](/commands/hugo_import_jekyll/) - hugo import from Jekyll

###### Auto generated by spf13/cobra on 13-Sep-2020
###### Auto generated by spf13/cobra on 20-Feb-2021
4 changes: 2 additions & 2 deletions content/en/commands/hugo_import_jekyll.md
@@ -1,5 +1,5 @@
---
date: 2020-09-13
date: 2021-02-20
title: "hugo import jekyll"
slug: hugo_import_jekyll
url: /commands/hugo_import_jekyll/
Expand Down Expand Up @@ -47,4 +47,4 @@ hugo import jekyll [flags]

* [hugo import](/commands/hugo_import/) - Import your site from others.

###### Auto generated by spf13/cobra on 13-Sep-2020
###### Auto generated by spf13/cobra on 20-Feb-2021
4 changes: 2 additions & 2 deletions content/en/commands/hugo_list.md
@@ -1,5 +1,5 @@
---
date: 2020-09-13
date: 2021-02-20
title: "hugo list"
slug: hugo_list
url: /commands/hugo_list/
Expand Down Expand Up @@ -46,4 +46,4 @@ List requires a subcommand, e.g. `hugo list drafts`.
* [hugo list expired](/commands/hugo_list_expired/) - List all posts already expired
* [hugo list future](/commands/hugo_list_future/) - List all posts dated in the future

###### Auto generated by spf13/cobra on 13-Sep-2020
###### Auto generated by spf13/cobra on 20-Feb-2021
4 changes: 2 additions & 2 deletions content/en/commands/hugo_list_all.md
@@ -1,5 +1,5 @@
---
date: 2020-09-13
date: 2021-02-20
title: "hugo list all"
slug: hugo_list_all
url: /commands/hugo_list_all/
Expand Down Expand Up @@ -44,4 +44,4 @@ hugo list all [flags]

* [hugo list](/commands/hugo_list/) - Listing out various types of content

###### Auto generated by spf13/cobra on 13-Sep-2020
###### Auto generated by spf13/cobra on 20-Feb-2021
4 changes: 2 additions & 2 deletions content/en/commands/hugo_list_drafts.md
@@ -1,5 +1,5 @@
---
date: 2020-09-13
date: 2021-02-20
title: "hugo list drafts"
slug: hugo_list_drafts
url: /commands/hugo_list_drafts/
Expand Down Expand Up @@ -44,4 +44,4 @@ hugo list drafts [flags]

* [hugo list](/commands/hugo_list/) - Listing out various types of content

###### Auto generated by spf13/cobra on 13-Sep-2020
###### Auto generated by spf13/cobra on 20-Feb-2021
4 changes: 2 additions & 2 deletions content/en/commands/hugo_list_expired.md
@@ -1,5 +1,5 @@
---
date: 2020-09-13
date: 2021-02-20
title: "hugo list expired"
slug: hugo_list_expired
url: /commands/hugo_list_expired/
Expand Down Expand Up @@ -44,4 +44,4 @@ hugo list expired [flags]

* [hugo list](/commands/hugo_list/) - Listing out various types of content

###### Auto generated by spf13/cobra on 13-Sep-2020
###### Auto generated by spf13/cobra on 20-Feb-2021
4 changes: 2 additions & 2 deletions content/en/commands/hugo_list_future.md
@@ -1,5 +1,5 @@
---
date: 2020-09-13
date: 2021-02-20
title: "hugo list future"
slug: hugo_list_future
url: /commands/hugo_list_future/
Expand Down Expand Up @@ -44,4 +44,4 @@ hugo list future [flags]

* [hugo list](/commands/hugo_list/) - Listing out various types of content

###### Auto generated by spf13/cobra on 13-Sep-2020
###### Auto generated by spf13/cobra on 20-Feb-2021

0 comments on commit 9d31f65

Please sign in to comment.