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 25, 2024
1 parent 8f939ed commit 770acf3
Show file tree
Hide file tree
Showing 6 changed files with 58 additions and 12 deletions.
9 changes: 5 additions & 4 deletions content/en/commands/hugo_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

4 changes: 2 additions & 2 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 Down
4 changes: 2 additions & 2 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 Down
4 changes: 2 additions & 2 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 Down
4 changes: 2 additions & 2 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 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
--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

0 comments on commit 770acf3

Please sign in to comment.