Skip to content

Commit 76ef3f4

Browse files
bepbep
committed
docs: Regen CLI docs
1 parent 0ccb6cd commit 76ef3f4

12 files changed

+114
-102
lines changed

‎docs/content/en/commands/hugo.md

+1
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ hugo [flags]
5656
--printPathWarnings print warnings on duplicate target paths etc.
5757
--printUnusedTemplates print warnings on unused templates.
5858
--quiet build in quiet mode
59+
--renderSegments strings named segments to render (configured in the segments config)
5960
--renderToMemory render to memory (mostly useful when running the server)
6061
-s, --source string filesystem path to read files relative from
6162
--templateMetrics display metrics about template executions

‎docs/content/en/commands/hugo_config.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,14 @@ hugo config [command] [flags]
1818
### Options
1919

2020
```
21-
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
22-
--cacheDir string filesystem path to cache directory
23-
-c, --contentDir string filesystem path to content directory
24-
--format string preferred file format (toml, yaml or json) (default "toml")
25-
-h, --help help for config
26-
--lang string the language to display config for. Defaults to the first language defined.
27-
-t, --theme strings themes to use (located in /themes/THEMENAME/)
21+
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
22+
--cacheDir string filesystem path to cache directory
23+
-c, --contentDir string filesystem path to content directory
24+
--format string preferred file format (toml, yaml or json) (default "toml")
25+
-h, --help help for config
26+
--lang string the language to display config for. Defaults to the first language defined.
27+
--renderSegments strings named segments to render (configured in the segments config)
28+
-t, --theme strings themes to use (located in /themes/THEMENAME/)
2829
```
2930

3031
### Options inherited from parent commands

‎docs/content/en/commands/hugo_config_mounts.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,12 @@ hugo config mounts [flags] [args]
1414
### Options
1515

1616
```
17-
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
18-
--cacheDir string filesystem path to cache directory
19-
-c, --contentDir string filesystem path to content directory
20-
-h, --help help for mounts
21-
-t, --theme strings themes to use (located in /themes/THEMENAME/)
17+
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
18+
--cacheDir string filesystem path to cache directory
19+
-c, --contentDir string filesystem path to content directory
20+
-h, --help help for mounts
21+
--renderSegments strings named segments to render (configured in the segments config)
22+
-t, --theme strings themes to use (located in /themes/THEMENAME/)
2223
```
2324

2425
### Options inherited from parent commands

‎docs/content/en/commands/hugo_mod_clean.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,14 @@ hugo mod clean [flags] [args]
1818
### Options
1919

2020
```
21-
--all clean entire module cache
22-
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
23-
--cacheDir string filesystem path to cache directory
24-
-c, --contentDir string filesystem path to content directory
25-
-h, --help help for clean
26-
--pattern string pattern matching module paths to clean (all if not set), e.g. "**hugo*"
27-
-t, --theme strings themes to use (located in /themes/THEMENAME/)
21+
--all clean entire module cache
22+
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
23+
--cacheDir string filesystem path to cache directory
24+
-c, --contentDir string filesystem path to content directory
25+
-h, --help help for clean
26+
--pattern string pattern matching module paths to clean (all if not set), e.g. "**hugo*"
27+
--renderSegments strings named segments to render (configured in the segments config)
28+
-t, --theme strings themes to use (located in /themes/THEMENAME/)
2829
```
2930

3031
### Options inherited from parent commands

‎docs/content/en/commands/hugo_mod_graph.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,13 @@ hugo mod graph [flags] [args]
2020
### Options
2121

2222
```
23-
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
24-
--cacheDir string filesystem path to cache directory
25-
--clean delete module cache for dependencies that fail verification
26-
-c, --contentDir string filesystem path to content directory
27-
-h, --help help for graph
28-
-t, --theme strings themes to use (located in /themes/THEMENAME/)
23+
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
24+
--cacheDir string filesystem path to cache directory
25+
--clean delete module cache for dependencies that fail verification
26+
-c, --contentDir string filesystem path to content directory
27+
-h, --help help for graph
28+
--renderSegments strings named segments to render (configured in the segments config)
29+
-t, --theme strings themes to use (located in /themes/THEMENAME/)
2930
```
3031

3132
### Options inherited from parent commands

‎docs/content/en/commands/hugo_mod_init.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,12 @@ hugo mod init [flags] [args]
2525
### Options
2626

2727
```
28-
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
29-
--cacheDir string filesystem path to cache directory
30-
-c, --contentDir string filesystem path to content directory
31-
-h, --help help for init
32-
-t, --theme strings themes to use (located in /themes/THEMENAME/)
28+
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
29+
--cacheDir string filesystem path to cache directory
30+
-c, --contentDir string filesystem path to content directory
31+
-h, --help help for init
32+
--renderSegments strings named segments to render (configured in the segments config)
33+
-t, --theme strings themes to use (located in /themes/THEMENAME/)
3334
```
3435

3536
### Options inherited from parent commands

‎docs/content/en/commands/hugo_mod_npm_pack.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,12 @@ hugo mod npm pack [flags] [args]
2828
### Options
2929

3030
```
31-
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
32-
--cacheDir string filesystem path to cache directory
33-
-c, --contentDir string filesystem path to content directory
34-
-h, --help help for pack
35-
-t, --theme strings themes to use (located in /themes/THEMENAME/)
31+
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
32+
--cacheDir string filesystem path to cache directory
33+
-c, --contentDir string filesystem path to content directory
34+
-h, --help help for pack
35+
--renderSegments strings named segments to render (configured in the segments config)
36+
-t, --theme strings themes to use (located in /themes/THEMENAME/)
3637
```
3738

3839
### Options inherited from parent commands

‎docs/content/en/commands/hugo_mod_tidy.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,12 @@ hugo mod tidy [flags] [args]
1414
### Options
1515

1616
```
17-
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
18-
--cacheDir string filesystem path to cache directory
19-
-c, --contentDir string filesystem path to content directory
20-
-h, --help help for tidy
21-
-t, --theme strings themes to use (located in /themes/THEMENAME/)
17+
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
18+
--cacheDir string filesystem path to cache directory
19+
-c, --contentDir string filesystem path to content directory
20+
-h, --help help for tidy
21+
--renderSegments strings named segments to render (configured in the segments config)
22+
-t, --theme strings themes to use (located in /themes/THEMENAME/)
2223
```
2324

2425
### Options inherited from parent commands

‎docs/content/en/commands/hugo_mod_vendor.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,12 @@ hugo mod vendor [flags] [args]
2020
### Options
2121

2222
```
23-
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
24-
--cacheDir string filesystem path to cache directory
25-
-c, --contentDir string filesystem path to content directory
26-
-h, --help help for vendor
27-
-t, --theme strings themes to use (located in /themes/THEMENAME/)
23+
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
24+
--cacheDir string filesystem path to cache directory
25+
-c, --contentDir string filesystem path to content directory
26+
-h, --help help for vendor
27+
--renderSegments strings named segments to render (configured in the segments config)
28+
-t, --theme strings themes to use (located in /themes/THEMENAME/)
2829
```
2930

3031
### Options inherited from parent commands

‎docs/content/en/commands/hugo_mod_verify.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,13 @@ hugo mod verify [flags] [args]
1818
### Options
1919

2020
```
21-
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
22-
--cacheDir string filesystem path to cache directory
23-
--clean delete module cache for dependencies that fail verification
24-
-c, --contentDir string filesystem path to content directory
25-
-h, --help help for verify
26-
-t, --theme strings themes to use (located in /themes/THEMENAME/)
21+
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
22+
--cacheDir string filesystem path to cache directory
23+
--clean delete module cache for dependencies that fail verification
24+
-c, --contentDir string filesystem path to content directory
25+
-h, --help help for verify
26+
--renderSegments strings named segments to render (configured in the segments config)
27+
-t, --theme strings themes to use (located in /themes/THEMENAME/)
2728
```
2829

2930
### Options inherited from parent commands

‎docs/content/en/commands/hugo_new_content.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,15 @@ hugo new content [path] [flags]
2525
### Options
2626

2727
```
28-
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
29-
--cacheDir string filesystem path to cache directory
30-
-c, --contentDir string filesystem path to content directory
31-
--editor string edit new content with this editor, if provided
32-
-f, --force overwrite file if it already exists
33-
-h, --help help for content
34-
-k, --kind string content type to create
35-
-t, --theme strings themes to use (located in /themes/THEMENAME/)
28+
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
29+
--cacheDir string filesystem path to cache directory
30+
-c, --contentDir string filesystem path to content directory
31+
--editor string edit new content with this editor, if provided
32+
-f, --force overwrite file if it already exists
33+
-h, --help help for content
34+
-k, --kind string content type to create
35+
--renderSegments strings named segments to render (configured in the segments config)
36+
-t, --theme strings themes to use (located in /themes/THEMENAME/)
3637
```
3738

3839
### Options inherited from parent commands

‎docs/content/en/commands/hugo_server.md

+44-43
Original file line numberDiff line numberDiff line change
@@ -28,49 +28,50 @@ hugo server [command] [flags]
2828
### Options
2929

3030
```
31-
--appendPort append port to baseURL (default true)
32-
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
33-
--bind string interface to which the server will bind (default "127.0.0.1")
34-
-D, --buildDrafts include content marked as draft
35-
-E, --buildExpired include expired content
36-
-F, --buildFuture include content with publishdate in the future
37-
--cacheDir string filesystem path to cache directory
38-
--cleanDestinationDir remove files from destination not found in static directories
39-
-c, --contentDir string filesystem path to content directory
40-
--disableBrowserError do not show build errors in the browser
41-
--disableFastRender enables full re-renders on changes
42-
--disableKinds strings disable different kind of pages (home, RSS etc.)
43-
--disableLiveReload watch without enabling live browser reload on rebuild
44-
--enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages
45-
--forceSyncStatic copy all files when static is changed.
46-
--gc enable to run some cleanup tasks (remove unused cache files) after the build
47-
-h, --help help for server
48-
--ignoreCache ignores the cache directory
49-
-l, --layoutDir string filesystem path to layout directory
50-
--liveReloadPort int port for live reloading (i.e. 443 in HTTPS proxy situations) (default -1)
51-
--minify minify any supported output format (HTML, XML etc.)
52-
--navigateToChanged navigate to changed content file on live browser reload
53-
--noBuildLock don't create .hugo_build.lock file
54-
--noChmod don't sync permission mode of files
55-
--noHTTPCache prevent HTTP caching
56-
--noTimes don't sync modification time of files
57-
--panicOnWarning panic on first WARNING log
58-
--poll string set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes
59-
-p, --port int port on which the server will listen (default 1313)
60-
--pprof enable the pprof server (port 8080)
61-
--printI18nWarnings print missing translations
62-
--printMemoryUsage print memory usage to screen at intervals
63-
--printPathWarnings print warnings on duplicate target paths etc.
64-
--printUnusedTemplates print warnings on unused templates.
65-
--renderStaticToDisk serve static files from disk and dynamic files from memory
66-
--templateMetrics display metrics about template executions
67-
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics
68-
-t, --theme strings themes to use (located in /themes/THEMENAME/)
69-
--tlsAuto generate and use locally-trusted certificates.
70-
--tlsCertFile string path to TLS certificate file
71-
--tlsKeyFile string path to TLS key file
72-
--trace file write trace to file (not useful in general)
73-
-w, --watch watch filesystem for changes and recreate as needed (default true)
31+
--appendPort append port to baseURL (default true)
32+
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
33+
--bind string interface to which the server will bind (default "127.0.0.1")
34+
-D, --buildDrafts include content marked as draft
35+
-E, --buildExpired include expired content
36+
-F, --buildFuture include content with publishdate in the future
37+
--cacheDir string filesystem path to cache directory
38+
--cleanDestinationDir remove files from destination not found in static directories
39+
-c, --contentDir string filesystem path to content directory
40+
--disableBrowserError do not show build errors in the browser
41+
--disableFastRender enables full re-renders on changes
42+
--disableKinds strings disable different kind of pages (home, RSS etc.)
43+
--disableLiveReload watch without enabling live browser reload on rebuild
44+
--enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages
45+
--forceSyncStatic copy all files when static is changed.
46+
--gc enable to run some cleanup tasks (remove unused cache files) after the build
47+
-h, --help help for server
48+
--ignoreCache ignores the cache directory
49+
-l, --layoutDir string filesystem path to layout directory
50+
--liveReloadPort int port for live reloading (i.e. 443 in HTTPS proxy situations) (default -1)
51+
--minify minify any supported output format (HTML, XML etc.)
52+
--navigateToChanged navigate to changed content file on live browser reload
53+
--noBuildLock don't create .hugo_build.lock file
54+
--noChmod don't sync permission mode of files
55+
--noHTTPCache prevent HTTP caching
56+
--noTimes don't sync modification time of files
57+
--panicOnWarning panic on first WARNING log
58+
--poll string set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes
59+
-p, --port int port on which the server will listen (default 1313)
60+
--pprof enable the pprof server (port 8080)
61+
--printI18nWarnings print missing translations
62+
--printMemoryUsage print memory usage to screen at intervals
63+
--printPathWarnings print warnings on duplicate target paths etc.
64+
--printUnusedTemplates print warnings on unused templates.
65+
--renderSegments strings named segments to render (configured in the segments config)
66+
--renderStaticToDisk serve static files from disk and dynamic files from memory
67+
--templateMetrics display metrics about template executions
68+
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics
69+
-t, --theme strings themes to use (located in /themes/THEMENAME/)
70+
--tlsAuto generate and use locally-trusted certificates.
71+
--tlsCertFile string path to TLS certificate file
72+
--tlsKeyFile string path to TLS key file
73+
--trace file write trace to file (not useful in general)
74+
-w, --watch watch filesystem for changes and recreate as needed (default true)
7475
```
7576

7677
### Options inherited from parent commands

0 commit comments

Comments
 (0)