phoenix/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-07-08 10:06:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update overview/usage

Browse source
This commit is contained in:
Albert Nigmatzianov 2017-05-23 21:55:35 +02:00
parent 93cab620d7
commit 710300cb76
1 changed files with 38 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
docs/content/overview/usage.md
View file

@ -29,10 +29,12 @@ Usage:
Available Commands: Available Commands:
benchmark Benchmark Hugo by building a site a number of times. benchmark Benchmark Hugo by building a site a number of times.
check Contains some verification checks
config Print the site configuration config Print the site configuration
convert Convert your content to different formats convert Convert your content to different formats
env Print Hugo version and environment info env Print Hugo version and environment info
gen A collection of several useful generators. gen A collection of several useful generators.
help Help about any command
import Import your site from others. import Import your site from others.
list Listing out various types of content list Listing out various types of content
new Create new content for your site new Create new content for your site
@ -47,37 +49,37 @@ Flags:
-F, --buildFuture include content with publishdate in the future -F, --buildFuture include content with publishdate in the future
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--canonifyURLs if true, all relative URLs will be canonicalized using baseURL --canonifyURLs if true, all relative URLs will be canonicalized using baseURL
--cleanDestinationDir Remove files from destination not found in static directories --cleanDestinationDir remove files from destination not found in static directories
--config string config file (default is path/config.yaml|json|toml) --config string config file (default is path/config.yaml|json|toml)
-c, --contentDir string filesystem path to content directory -c, --contentDir string filesystem path to content directory
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
--disable404 Do not render 404 page --disable404 do not render 404 page
--disableRSS Do not build RSS files --disableKinds stringSlice disable different kind of pages (home, RSS etc.)
--disableSitemap Do not build Sitemap file --disableRSS do not build RSS files
--enableGitInfo Add Git revision, date and author info to the pages --disableSitemap do not build Sitemap file
--forceSyncStatic Copy all files when static is changed. --enableGitInfo add Git revision, date and author info to the pages
--i18n-warnings Print missing translations --forceSyncStatic copy all files when static is changed.
--ignoreCache Ignores the cache directory -h, --help help for hugo
--i18n-warnings print missing translations
--ignoreCache ignores the cache directory
-l, --layoutDir string filesystem path to layout directory -l, --layoutDir string filesystem path to layout directory
--log Enable Logging --log enable Logging
--logFile string Log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)
--noChmod Don't sync permission mode of files --noChmod don't sync permission mode of files
--noTimes Don't sync modification time of files --noTimes don't sync modification time of files
--pluralizeListTitles Pluralize titles in lists using inflect (default true) --pluralizeListTitles pluralize titles in lists using inflect (default true)
--preserveTaxonomyNames Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") --preserveTaxonomyNames preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (only useful for benchmark testing) --renderToMemory render to memory (only useful for benchmark testing)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--stepAnalysis display memory and timing of different steps of the program --stepAnalysis display memory and timing of different steps of the program
-t, --theme string theme to use (located in /themes/THEMENAME/) -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/ --uglyURLs if true, use /filename.html instead of /filename/
-v, --verbose verbose output -v, --verbose verbose output
--verboseLog verbose logging --verboseLog verbose logging
-w, --watch watch filesystem for changes and recreate as needed -w, --watch watch filesystem for changes and recreate as needed
Additional help topics:
hugo check Contains some verification checks
Use "hugo [command] --help" for more information about a command. Use "hugo [command] --help" for more information about a command.
{{< /nohighlight >}} {{< /nohighlight >}}