Skip to content

Commit

Permalink
Document templateMetrics usage
Browse files Browse the repository at this point in the history
Fixes #213
  • Loading branch information
moorereason authored and digitalcraftsman committed Sep 29, 2017
1 parent 67ad366 commit 50e0459
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 4 deletions.
3 changes: 1 addition & 2 deletions content/commands/hugo.md
@@ -1,5 +1,5 @@
--- ---
date: 2017-09-26T21:11:49+02:00 date: 2017-09-26T17:09:31-05:00
title: "hugo" title: "hugo"
slug: hugo slug: hugo
url: /commands/hugo/ url: /commands/hugo/
Expand Down Expand Up @@ -67,7 +67,6 @@ hugo [flags]


### SEE ALSO ### SEE ALSO
* [hugo benchmark](/commands/hugo_benchmark/) - Benchmark Hugo by building a site a number of times. * [hugo benchmark](/commands/hugo_benchmark/) - Benchmark Hugo by building a site a number of times.
* [hugo check](/commands/hugo_check/) - Contains some verification checks
* [hugo config](/commands/hugo_config/) - Print the site configuration * [hugo config](/commands/hugo_config/) - Print the site configuration
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
* [hugo env](/commands/hugo_env/) - Print Hugo version and environment info * [hugo env](/commands/hugo_env/) - Print Hugo version and environment info
Expand Down
2 changes: 2 additions & 0 deletions content/getting-started/configuration.md
Expand Up @@ -151,6 +151,8 @@ source: ""
staticDir: "static" staticDir: "static"
# display memory and timing of different steps of the program # display memory and timing of different steps of the program
stepAnalysis: false stepAnalysis: false
# display metrics about template executions
templateMetrics: false
# theme to use (located by default in /themes/THEMENAME/) # theme to use (located by default in /themes/THEMENAME/)
themesDir: "themes" themesDir: "themes"
theme: "" theme: ""
Expand Down
10 changes: 8 additions & 2 deletions content/getting-started/usage.md
Expand Up @@ -44,7 +44,6 @@ 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
Expand All @@ -54,7 +53,7 @@ Available Commands:
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
server A high performance webserver server A high performance webserver
undraft Undraft changes the content's draft status from 'True' to 'False' undraft Undraft resets the content's draft status
version Print the version number of Hugo version Print the version number of Hugo
Flags: Flags:
Expand All @@ -67,6 +66,7 @@ Flags:
--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
--debug debug output
-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
--disableKinds stringSlice disable different kind of pages (home, RSS etc.) --disableKinds stringSlice disable different kind of pages (home, RSS etc.)
Expand All @@ -88,12 +88,18 @@ Flags:
--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
--templateMetrics display metrics about template executions
-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 --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.
``` ```


## The `hugo` Command ## The `hugo` Command
Expand Down

0 comments on commit 50e0459

Please sign in to comment.