github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-07 20:30:36 -05:00
Code Issues Projects Releases Packages Wiki Activity

docs: Regen CLI docs

Browse source
This commit is contained in:
Bjørn Erik Pedersen 2020-09-07 21:46:30 +02:00
parent e6cd9da42d
commit 8c490a73b3
No known key found for this signature in database
GPG key ID: 330E6E2BD4859D8F
36 changed files with 80 additions and 75 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/content/en/commands/hugo.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo"
slug: hugo
url: /commands/hugo/
@ -15,7 +15,7 @@ hugo is the main command, used to build your Hugo site.
Hugo is a Fast and Flexible Static Site Generator
built with love by spf13 and friends in Go.
Complete documentation is available at https://gohugo.io/.
Complete documentation is available at http://gohugo.io/.
```
hugo [flags]
@ -51,6 +51,7 @@ hugo [flags]
--noChmod don't sync permission mode of files
--noTimes don't sync modification time of files
--path-warnings print warnings on duplicate target paths etc.
--print-mem print memory usage to screen at intervals
--quiet build in quiet mode
--renderToMemory render to memory (only useful for benchmark testing)
-s, --source string filesystem path to read files relative from
@ -79,4 +80,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 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_check.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo check"
slug: hugo_check
url: /commands/hugo_check/
@ -40,4 +40,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 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_check_ulimit.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo check ulimit"
slug: hugo_check_ulimit
url: /commands/hugo_check_ulimit/
@ -44,4 +44,4 @@ hugo check ulimit [flags]
* [hugo check](/commands/hugo_check/) - Contains some verification checks
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_config.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo config"
slug: hugo_config
url: /commands/hugo_config/
@ -44,4 +44,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 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_config_mounts.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo config mounts"
slug: hugo_config_mounts
url: /commands/hugo_config_mounts/
@ -43,4 +43,4 @@ hugo config mounts [flags]
* [hugo config](/commands/hugo_config/) - Print the site configuration
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_convert.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo convert"
slug: hugo_convert
url: /commands/hugo_convert/
@ -46,4 +46,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 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_convert_toJSON.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo convert toJSON"
slug: hugo_convert_toJSON
url: /commands/hugo_convert_tojson/
@ -46,4 +46,4 @@ hugo convert toJSON [flags]
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_convert_toTOML.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo convert toTOML"
slug: hugo_convert_toTOML
url: /commands/hugo_convert_totoml/
@ -46,4 +46,4 @@ hugo convert toTOML [flags]
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_convert_toYAML.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo convert toYAML"
slug: hugo_convert_toYAML
url: /commands/hugo_convert_toyaml/
@ -46,4 +46,4 @@ hugo convert toYAML [flags]
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_deploy.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo deploy"
slug: hugo_deploy
url: /commands/hugo_deploy/
@ -53,4 +53,4 @@ hugo deploy [flags]
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_env.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo env"
slug: hugo_env
url: /commands/hugo_env/
@ -43,4 +43,4 @@ hugo env [flags]
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_gen.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo gen"
slug: hugo_gen
url: /commands/hugo_gen/
@ -43,4 +43,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 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_gen_autocomplete.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo gen autocomplete"
slug: hugo_gen_autocomplete
url: /commands/hugo_gen_autocomplete/
@ -61,4 +61,4 @@ hugo gen autocomplete [flags]
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_gen_chromastyles.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo gen chromastyles"
slug: hugo_gen_chromastyles
url: /commands/hugo_gen_chromastyles/
@ -48,4 +48,4 @@ hugo gen chromastyles [flags]
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

6
docs/content/en/commands/hugo_gen_doc.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo gen doc"
slug: hugo_gen_doc
url: /commands/hugo_gen_doc/
@ -13,7 +13,7 @@ Generate Markdown documentation for the Hugo CLI.
Generate Markdown documentation for the Hugo CLI.
This command is, mostly, used to create up-to-date documentation
of Hugo's command-line interface for https://gohugo.io/.
of Hugo's command-line interface for http://gohugo.io/.
It creates one Markdown file per command with front matter suitable
for rendering in Hugo.
@ -50,4 +50,4 @@ hugo gen doc [flags]
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_gen_man.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo gen man"
slug: hugo_gen_man
url: /commands/hugo_gen_man/
@ -46,4 +46,4 @@ hugo gen man [flags]
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_import.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo import"
slug: hugo_import
url: /commands/hugo_import/
@ -42,4 +42,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 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_import_jekyll.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo import jekyll"
slug: hugo_import_jekyll
url: /commands/hugo_import_jekyll/
@ -46,4 +46,4 @@ hugo import jekyll [flags]
* [hugo import](/commands/hugo_import/) - Import your site from others.
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_list.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo list"
slug: hugo_list
url: /commands/hugo_list/
@ -45,4 +45,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 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_list_all.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo list all"
slug: hugo_list_all
url: /commands/hugo_list_all/
@ -43,4 +43,4 @@ hugo list all [flags]
* [hugo list](/commands/hugo_list/) - Listing out various types of content
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_list_drafts.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo list drafts"
slug: hugo_list_drafts
url: /commands/hugo_list_drafts/
@ -43,4 +43,4 @@ hugo list drafts [flags]
* [hugo list](/commands/hugo_list/) - Listing out various types of content
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_list_expired.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo list expired"
slug: hugo_list_expired
url: /commands/hugo_list_expired/
@ -43,4 +43,4 @@ hugo list expired [flags]
* [hugo list](/commands/hugo_list/) - Listing out various types of content
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_list_future.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo list future"
slug: hugo_list_future
url: /commands/hugo_list_future/
@ -43,4 +43,4 @@ hugo list future [flags]
* [hugo list](/commands/hugo_list/) - Listing out various types of content
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

5
docs/content/en/commands/hugo_mod.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo mod"
slug: hugo_mod
url: /commands/hugo_mod/
@ -47,6 +47,7 @@ See https://gohugo.io/hugo-modules/ for more information.
--noChmod don't sync permission mode of files
--noTimes don't sync modification time of files
--path-warnings print warnings on duplicate target paths etc.
--print-mem print memory usage to screen at intervals
--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/)
@ -81,4 +82,4 @@ See https://gohugo.io/hugo-modules/ for more information.
* [hugo mod vendor](/commands/hugo_mod_vendor/) - Vendor all module dependencies into the _vendor directory.
* [hugo mod verify](/commands/hugo_mod_verify/) - Verify dependencies.
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

5
docs/content/en/commands/hugo_mod_clean.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo mod clean"
slug: hugo_mod_clean
url: /commands/hugo_mod_clean/
@ -15,6 +15,7 @@ Delete the Hugo Module cache for the current project.
Note that after you run this command, all of your dependencies will be re-downloaded next time you run "hugo".
Also note that if you configure a positive maxAge for the "modules" file cache, it will also be cleaned as part of "hugo --gc".
```
@ -50,4 +51,4 @@ hugo mod clean [flags]
* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers.
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

6
docs/content/en/commands/hugo_mod_get.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo mod get"
slug: hugo_mod_get
url: /commands/hugo_mod_get/
@ -18,7 +18,7 @@ Some examples:
Install the latest version possible for a given module:
hugo mod get github.com/gohugoio/testshortcodes
Install a specific version:
hugo mod get github.com/gohugoio/testshortcodes@v0.3.0
@ -69,4 +69,4 @@ hugo mod get [flags]
* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers.
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_mod_graph.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo mod graph"
slug: hugo_mod_graph
url: /commands/hugo_mod_graph/
@ -45,4 +45,4 @@ hugo mod graph [flags]
* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers.
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_mod_init.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo mod init"
slug: hugo_mod_init
url: /commands/hugo_mod_init/
@ -50,4 +50,4 @@ hugo mod init [flags]
* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers.
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_mod_tidy.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo mod tidy"
slug: hugo_mod_tidy
url: /commands/hugo_mod_tidy/
@ -43,4 +43,4 @@ hugo mod tidy [flags]
* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers.
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_mod_vendor.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo mod vendor"
slug: hugo_mod_vendor
url: /commands/hugo_mod_vendor/
@ -46,4 +46,4 @@ hugo mod vendor [flags]
* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers.
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_mod_verify.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo mod verify"
slug: hugo_mod_verify
url: /commands/hugo_mod_verify/
@ -45,4 +45,4 @@ hugo mod verify [flags]
* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers.
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

5
docs/content/en/commands/hugo_new.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo new"
slug: hugo_new
url: /commands/hugo_new/
@ -48,6 +48,7 @@ hugo new [path] [flags]
--noChmod don't sync permission mode of files
--noTimes don't sync modification time of files
--path-warnings print warnings on duplicate target paths etc.
--print-mem print memory usage to screen at intervals
--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/)
@ -77,4 +78,4 @@ hugo new [path] [flags]
* [hugo new site](/commands/hugo_new_site/) - Create a new site (skeleton)
* [hugo new theme](/commands/hugo_new_theme/) - Create a new theme
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_new_site.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo new site"
slug: hugo_new_site
url: /commands/hugo_new_site/
@ -47,4 +47,4 @@ hugo new site [path] [flags]
* [hugo new](/commands/hugo_new/) - Create new content for your site
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_new_theme.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo new theme"
slug: hugo_new_theme
url: /commands/hugo_new_theme/
@ -46,4 +46,4 @@ hugo new theme [name] [flags]
* [hugo new](/commands/hugo_new/) - Create new content for your site
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

5
docs/content/en/commands/hugo_server.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo server"
slug: hugo_server
url: /commands/hugo_server/
@ -61,6 +61,7 @@ hugo server [flags]
--noTimes don't sync modification time of files
--path-warnings print warnings on duplicate target paths etc.
-p, --port int port on which the server will listen (default 1313)
--print-mem print memory usage to screen at intervals
--renderToDisk render to Destination path (default is render to memory & serve from there)
--templateMetrics display metrics about template executions
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics
@ -90,4 +91,4 @@ hugo server [flags]
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020

4
docs/content/en/commands/hugo_version.md
View file

@ -1,5 +1,5 @@
---
date: 2020-03-03
date: 2020-09-07
title: "hugo version"
slug: hugo_version
url: /commands/hugo_version/
@ -43,4 +43,4 @@ hugo version [flags]
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 3-Mar-2020
###### Auto generated by spf13/cobra on 7-Sep-2020