Skip to content

Commit

Permalink
Update CLI docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jmooring committed May 30, 2024
1 parent 993aa40 commit 9c7a700
Show file tree
Hide file tree
Showing 43 changed files with 101 additions and 55 deletions.
2 changes: 1 addition & 1 deletion content/en/commands/hugo.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ hugo [flags]
--printUnusedTemplates print warnings on unused templates.
--quiet build in quiet mode
--renderSegments strings named segments to render (configured in the segments config)
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from
--templateMetrics display metrics about template executions
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics
Expand Down
2 changes: 1 addition & 1 deletion content/en/commands/hugo_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ See each sub-command's help for details on how to use the generated script.
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
Expand Down
2 changes: 1 addition & 1 deletion content/en/commands/hugo_completion_bash.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ hugo completion bash
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
Expand Down
2 changes: 1 addition & 1 deletion content/en/commands/hugo_completion_fish.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ hugo completion fish [flags]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
Expand Down
2 changes: 1 addition & 1 deletion content/en/commands/hugo_completion_powershell.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ hugo completion powershell [flags]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
Expand Down
2 changes: 1 addition & 1 deletion content/en/commands/hugo_completion_zsh.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ hugo completion zsh [flags]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
Expand Down
2 changes: 1 addition & 1 deletion content/en/commands/hugo_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ hugo config [command] [flags]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
Expand Down
2 changes: 1 addition & 1 deletion content/en/commands/hugo_config_mounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ hugo config mounts [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
Expand Down
2 changes: 1 addition & 1 deletion content/en/commands/hugo_convert.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ See convert's subcommands toJSON, toTOML and toYAML for more information.
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
Expand Down
2 changes: 1 addition & 1 deletion content/en/commands/hugo_convert_toJSON.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ hugo convert toJSON [flags] [args]
--logLevel string log level (debug|info|warn|error)
-o, --output string filesystem path to write files to
--quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-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
Expand Down
2 changes: 1 addition & 1 deletion content/en/commands/hugo_convert_toTOML.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ hugo convert toTOML [flags] [args]
--logLevel string log level (debug|info|warn|error)
-o, --output string filesystem path to write files to
--quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-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
Expand Down
2 changes: 1 addition & 1 deletion content/en/commands/hugo_convert_toYAML.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ hugo convert toYAML [flags] [args]
--logLevel string log level (debug|info|warn|error)
-o, --output string filesystem path to write files to
--quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-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
Expand Down
2 changes: 1 addition & 1 deletion content/en/commands/hugo_deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ hugo deploy [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
Expand Down
2 changes: 1 addition & 1 deletion content/en/commands/hugo_env.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ hugo env [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
Expand Down
2 changes: 1 addition & 1 deletion content/en/commands/hugo_gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ A collection of several useful generators.
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
Expand Down
2 changes: 1 addition & 1 deletion content/en/commands/hugo_gen_chromastyles.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ hugo gen chromastyles [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
Expand Down
2 changes: 1 addition & 1 deletion content/en/commands/hugo_gen_doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ hugo gen doc [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
Expand Down
2 changes: 1 addition & 1 deletion content/en/commands/hugo_gen_man.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ hugo gen man [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
Expand Down
2 changes: 1 addition & 1 deletion content/en/commands/hugo_import.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_p
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
Expand Down
2 changes: 1 addition & 1 deletion content/en/commands/hugo_import_jekyll.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ hugo import jekyll [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
Expand Down
11 changes: 6 additions & 5 deletions content/en/commands/hugo_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ List requires a subcommand, e.g. hugo list drafts
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
Expand All @@ -40,8 +40,9 @@ List requires a subcommand, e.g. hugo list drafts
### SEE ALSO

* [hugo](/commands/hugo/) - hugo builds your site
* [hugo list all](/commands/hugo_list_all/) - List all posts
* [hugo list drafts](/commands/hugo_list_drafts/) - List all 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
* [hugo list all](/commands/hugo_list_all/) - List all content
* [hugo list drafts](/commands/hugo_list_drafts/) - List draft content
* [hugo list expired](/commands/hugo_list_expired/) - List expired content
* [hugo list future](/commands/hugo_list_future/) - List future content
* [hugo list published](/commands/hugo_list_published/) - List published content

6 changes: 3 additions & 3 deletions content/en/commands/hugo_list_all.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ url: /commands/hugo_list_all/
---
## hugo list all

List all posts
List all content

### Synopsis

List all of the posts in your content directory, include drafts, future and expired pages.
List all content including draft, future, and expired.

```
hugo list all [flags] [args]
Expand All @@ -33,7 +33,7 @@ hugo list all [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
Expand Down
6 changes: 3 additions & 3 deletions content/en/commands/hugo_list_drafts.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ url: /commands/hugo_list_drafts/
---
## hugo list drafts

List all drafts
List draft content

### Synopsis

List all of the drafts in your content directory.
List draft content.

```
hugo list drafts [flags] [args]
Expand All @@ -33,7 +33,7 @@ hugo list drafts [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
Expand Down
6 changes: 3 additions & 3 deletions content/en/commands/hugo_list_expired.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ url: /commands/hugo_list_expired/
---
## hugo list expired

List all posts already expired
List expired content

### Synopsis

List all of the posts in your content directory which has already expired.
List content with a past expiration date.

```
hugo list expired [flags] [args]
Expand All @@ -33,7 +33,7 @@ hugo list expired [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
Expand Down
6 changes: 3 additions & 3 deletions content/en/commands/hugo_list_future.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ url: /commands/hugo_list_future/
---
## hugo list future

List all posts dated in the future
List future content

### Synopsis

List all of the posts in your content directory which will be posted in the future.
List content with a future publication date.

```
hugo list future [flags] [args]
Expand All @@ -33,7 +33,7 @@ hugo list future [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-M, --renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
Expand Down
45 changes: 45 additions & 0 deletions content/en/commands/hugo_list_published.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: "hugo list published"
slug: hugo_list_published
url: /commands/hugo_list_published/
---
## hugo list published

List published content

### Synopsis

List content that is not draft, future, or expired.

```
hugo list published [flags] [args]
```

### Options

```
-h, --help help for published
```

### Options inherited from parent commands

```
--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
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode
-M, --renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
```

### SEE ALSO

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

Loading

0 comments on commit 9c7a700

Please sign in to comment.