summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAlbert Nigmatzianov <albertnigma@gmail.com>2017-05-23 21:55:35 +0200
committerAlbert Nigmatzianov <albertnigma@gmail.com>2017-05-28 12:10:16 +0200
commit710300cb768f43db397a0ea91b79f3b916fceac4 (patch)
tree914e5d79b3d0815499950a92299ede31a45e3681 /docs
parent93cab620d71d30e1203c4dab5e3791dace19a9f8 (diff)
docs: Update overview/usage
Diffstat (limited to 'docs')
-rw-r--r--docs/content/overview/usage.md74
1 files changed, 38 insertions, 36 deletions
diff --git a/docs/content/overview/usage.md b/docs/content/overview/usage.md
index 35479aee6..d7c7f7772 100644
--- a/docs/content/overview/usage.md
+++ b/docs/content/overview/usage.md
@@ -29,10 +29,12 @@ Usage:
Available Commands:
benchmark Benchmark Hugo by building a site a number of times.
+ check Contains some verification checks
config Print the site configuration
convert Convert your content to different formats
env Print Hugo version and environment info
gen A collection of several useful generators.
+ help Help about any command
import Import your site from others.
list Listing out various types of content
new Create new content for your site
@@ -41,42 +43,42 @@ Available Commands:
version Print the version number of Hugo
Flags:
- -b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/
- -D, --buildDrafts include content marked as draft
- -E, --buildExpired include expired content
- -F, --buildFuture include content with publishdate in the future
- --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
- --canonifyURLs if true, all relative URLs will be canonicalized using baseURL
- --cleanDestinationDir Remove files from destination not found in static directories
- --config string config file (default is path/config.yaml|json|toml)
- -c, --contentDir string filesystem path to content directory
- -d, --destination string filesystem path to write files to
- --disable404 Do not render 404 page
- --disableRSS Do not build RSS files
- --disableSitemap Do not build Sitemap file
- --enableGitInfo Add Git revision, date and author info to the pages
- --forceSyncStatic Copy all files when static is changed.
- --i18n-warnings Print missing translations
- --ignoreCache Ignores the cache directory
- -l, --layoutDir string filesystem path to layout directory
- --log Enable Logging
- --logFile string Log File path (if set, logging enabled automatically)
- --noChmod Don't sync permission mode of files
- --noTimes Don't sync modification time of files
- --pluralizeListTitles Pluralize titles in lists using inflect (default true)
- --preserveTaxonomyNames Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
- --quiet build in quiet mode
- --renderToMemory render to memory (only useful for benchmark testing)
- -s, --source string filesystem path to read files relative from
- --stepAnalysis display memory and timing of different steps of the program
- -t, --theme string theme to use (located in /themes/THEMENAME/)
- --uglyURLs if true, use /filename.html instead of /filename/
- -v, --verbose verbose output
- --verboseLog verbose logging
- -w, --watch watch filesystem for changes and recreate as needed
-
-Additional help topics:
- hugo check Contains some verification checks
+ -b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/
+ -D, --buildDrafts include content marked as draft
+ -E, --buildExpired include expired content
+ -F, --buildFuture include content with publishdate in the future
+ --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
+ --canonifyURLs if true, all relative URLs will be canonicalized using baseURL
+ --cleanDestinationDir remove files from destination not found in static directories
+ --config string config file (default is path/config.yaml|json|toml)
+ -c, --contentDir string filesystem path to content directory
+ -d, --destination string filesystem path to write files to
+ --disable404 do not render 404 page
+ --disableKinds stringSlice disable different kind of pages (home, RSS etc.)
+ --disableRSS do not build RSS files
+ --disableSitemap do not build Sitemap file
+ --enableGitInfo add Git revision, date and author info to the pages
+ --forceSyncStatic copy all files when static is changed.
+ -h, --help help for hugo
+ --i18n-warnings print missing translations
+ --ignoreCache ignores the cache directory
+ -l, --layoutDir string filesystem path to layout directory
+ --log enable Logging
+ --logFile string log File path (if set, logging enabled automatically)
+ --noChmod don't sync permission mode of files
+ --noTimes don't sync modification time of files
+ --pluralizeListTitles pluralize titles in lists using inflect (default true)
+ --preserveTaxonomyNames preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
+ --quiet build in quiet mode
+ --renderToMemory render to memory (only useful for benchmark testing)
+ -s, --source string filesystem path to read files relative from
+ --stepAnalysis display memory and timing of different steps of the program
+ -t, --theme string theme to use (located in /themes/THEMENAME/)
+ --themesDir string filesystem path to themes directory
+ --uglyURLs if true, use /filename.html instead of /filename/
+ -v, --verbose verbose output
+ --verboseLog verbose logging
+ -w, --watch watch filesystem for changes and recreate as needed
Use "hugo [command] --help" for more information about a command.
{{< /nohighlight >}}