From 50e04593a708eea35987dc68e3b3f983bb10d980 Mon Sep 17 00:00:00 2001 From: Cameron Moore Date: Fri, 29 Sep 2017 06:55:39 -0500 Subject: [PATCH] Document templateMetrics usage Fixes #213 --- content/commands/hugo.md | 3 +-- content/getting-started/configuration.md | 2 ++ content/getting-started/usage.md | 10 ++++++++-- 3 files changed, 11 insertions(+), 4 deletions(-) diff --git a/content/commands/hugo.md b/content/commands/hugo.md index d3b0b3581..5521ee968 100644 --- a/content/commands/hugo.md +++ b/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" slug: hugo url: /commands/hugo/ @@ -67,7 +67,6 @@ hugo [flags] ### SEE ALSO * [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 convert](/commands/hugo_convert/) - Convert your content to different formats * [hugo env](/commands/hugo_env/) - Print Hugo version and environment info diff --git a/content/getting-started/configuration.md b/content/getting-started/configuration.md index b81d878b3..dea4bbb48 100644 --- a/content/getting-started/configuration.md +++ b/content/getting-started/configuration.md @@ -151,6 +151,8 @@ source: "" staticDir: "static" # display memory and timing of different steps of the program stepAnalysis: false +# display metrics about template executions +templateMetrics: false # theme to use (located by default in /themes/THEMENAME/) themesDir: "themes" theme: "" diff --git a/content/getting-started/usage.md b/content/getting-started/usage.md index 39b8a4912..198dc25f9 100644 --- a/content/getting-started/usage.md +++ b/content/getting-started/usage.md @@ -44,7 +44,6 @@ 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 @@ -54,7 +53,7 @@ Available Commands: list Listing out various types of content new Create new content for your site 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 Flags: @@ -67,6 +66,7 @@ Flags: --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 + --debug debug output -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.) @@ -88,12 +88,18 @@ Flags: --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 + --templateMetrics display metrics about template executions -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 + +Additional help topics: + hugo check Contains some verification checks + +Use "hugo [command] --help" for more information about a command. ``` ## The `hugo` Command