mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-29 03:12:05 -05:00
Merge commit 'ecf5e081b5540e69f4af330233f39a07baf53846'
This commit is contained in:
commit
5c31e0c341
46 changed files with 12024 additions and 200 deletions
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T17:09:31-05:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo"
|
||||
slug: hugo
|
||||
url: /commands/hugo/
|
||||
|
@ -37,7 +37,7 @@ hugo [flags]
|
|||
--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.)
|
||||
--disableKinds strings 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
|
||||
|
@ -57,6 +57,7 @@ hugo [flags]
|
|||
-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
|
||||
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics
|
||||
-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/
|
||||
|
@ -67,6 +68,7 @@ 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
|
||||
|
@ -78,4 +80,4 @@ hugo [flags]
|
|||
* [hugo undraft](/commands/hugo_undraft/) - Undraft resets the content's draft status
|
||||
* [hugo version](/commands/hugo_version/) - Print the version number of Hugo
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo benchmark"
|
||||
slug: hugo_benchmark
|
||||
url: /commands/hugo_benchmark/
|
||||
|
@ -33,7 +33,7 @@ hugo benchmark [flags]
|
|||
--cpuprofile string path/filename for the CPU profile file
|
||||
-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.)
|
||||
--disableKinds strings 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
|
||||
|
@ -51,6 +51,7 @@ hugo benchmark [flags]
|
|||
-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
|
||||
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics
|
||||
-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/
|
||||
|
@ -71,4 +72,4 @@ hugo benchmark [flags]
|
|||
### SEE ALSO
|
||||
* [hugo](/commands/hugo/) - hugo builds your site
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo check"
|
||||
slug: hugo_check
|
||||
url: /commands/hugo_check/
|
||||
|
@ -35,4 +35,4 @@ Contains some verification checks
|
|||
* [hugo](/commands/hugo/) - hugo builds your site
|
||||
* [hugo check ulimit](/commands/hugo_check_ulimit/) - Check system ulimit settings
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo check ulimit"
|
||||
slug: hugo_check_ulimit
|
||||
url: /commands/hugo_check_ulimit/
|
||||
|
@ -39,4 +39,4 @@ hugo check ulimit [flags]
|
|||
### SEE ALSO
|
||||
* [hugo check](/commands/hugo_check/) - Contains some verification checks
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo config"
|
||||
slug: hugo_config
|
||||
url: /commands/hugo_config/
|
||||
|
@ -38,4 +38,4 @@ hugo config [flags]
|
|||
### SEE ALSO
|
||||
* [hugo](/commands/hugo/) - hugo builds your site
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo convert"
|
||||
slug: hugo_convert
|
||||
url: /commands/hugo_convert/
|
||||
|
@ -42,4 +42,4 @@ See convert's subcommands toJSON, toTOML and toYAML for more information.
|
|||
* [hugo convert toTOML](/commands/hugo_convert_totoml/) - Convert front matter to TOML
|
||||
* [hugo convert toYAML](/commands/hugo_convert_toyaml/) - Convert front matter to YAML
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo convert toJSON"
|
||||
slug: hugo_convert_toJSON
|
||||
url: /commands/hugo_convert_tojson/
|
||||
|
@ -42,4 +42,4 @@ hugo convert toJSON [flags]
|
|||
### SEE ALSO
|
||||
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo convert toTOML"
|
||||
slug: hugo_convert_toTOML
|
||||
url: /commands/hugo_convert_totoml/
|
||||
|
@ -42,4 +42,4 @@ hugo convert toTOML [flags]
|
|||
### SEE ALSO
|
||||
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo convert toYAML"
|
||||
slug: hugo_convert_toYAML
|
||||
url: /commands/hugo_convert_toyaml/
|
||||
|
@ -42,4 +42,4 @@ hugo convert toYAML [flags]
|
|||
### SEE ALSO
|
||||
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo env"
|
||||
slug: hugo_env
|
||||
url: /commands/hugo_env/
|
||||
|
@ -38,4 +38,4 @@ hugo env [flags]
|
|||
### SEE ALSO
|
||||
* [hugo](/commands/hugo/) - hugo builds your site
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo gen"
|
||||
slug: hugo_gen
|
||||
url: /commands/hugo_gen/
|
||||
|
@ -38,4 +38,4 @@ A collection of several useful generators.
|
|||
* [hugo gen doc](/commands/hugo_gen_doc/) - Generate Markdown documentation for the Hugo CLI.
|
||||
* [hugo gen man](/commands/hugo_gen_man/) - Generate man pages for the Hugo CLI
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo gen autocomplete"
|
||||
slug: hugo_gen_autocomplete
|
||||
url: /commands/hugo_gen_autocomplete/
|
||||
|
@ -56,4 +56,4 @@ hugo gen autocomplete [flags]
|
|||
### SEE ALSO
|
||||
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo gen chromastyles"
|
||||
slug: hugo_gen_chromastyles
|
||||
url: /commands/hugo_gen_chromastyles/
|
||||
|
@ -43,4 +43,4 @@ hugo gen chromastyles [flags]
|
|||
### SEE ALSO
|
||||
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo gen doc"
|
||||
slug: hugo_gen_doc
|
||||
url: /commands/hugo_gen_doc/
|
||||
|
@ -45,4 +45,4 @@ hugo gen doc [flags]
|
|||
### SEE ALSO
|
||||
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo gen man"
|
||||
slug: hugo_gen_man
|
||||
url: /commands/hugo_gen_man/
|
||||
|
@ -41,4 +41,4 @@ hugo gen man [flags]
|
|||
### SEE ALSO
|
||||
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo import"
|
||||
slug: hugo_import
|
||||
url: /commands/hugo_import/
|
||||
|
@ -37,4 +37,4 @@ Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_p
|
|||
* [hugo](/commands/hugo/) - hugo builds your site
|
||||
* [hugo import jekyll](/commands/hugo_import_jekyll/) - hugo import from Jekyll
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo import jekyll"
|
||||
slug: hugo_import_jekyll
|
||||
url: /commands/hugo_import_jekyll/
|
||||
|
@ -41,4 +41,4 @@ hugo import jekyll [flags]
|
|||
### SEE ALSO
|
||||
* [hugo import](/commands/hugo_import/) - Import your site from others.
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo list"
|
||||
slug: hugo_list
|
||||
url: /commands/hugo_list/
|
||||
|
@ -40,4 +40,4 @@ List requires a subcommand, e.g. `hugo list drafts`.
|
|||
* [hugo list expired](/commands/hugo_list_expired/) - List all posts already expired
|
||||
* [hugo list future](/commands/hugo_list_future/) - List all posts dated in the future
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo list drafts"
|
||||
slug: hugo_list_drafts
|
||||
url: /commands/hugo_list_drafts/
|
||||
|
@ -39,4 +39,4 @@ hugo list drafts [flags]
|
|||
### SEE ALSO
|
||||
* [hugo list](/commands/hugo_list/) - Listing out various types of content
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo list expired"
|
||||
slug: hugo_list_expired
|
||||
url: /commands/hugo_list_expired/
|
||||
|
@ -40,4 +40,4 @@ hugo list expired [flags]
|
|||
### SEE ALSO
|
||||
* [hugo list](/commands/hugo_list/) - Listing out various types of content
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo list future"
|
||||
slug: hugo_list_future
|
||||
url: /commands/hugo_list_future/
|
||||
|
@ -40,4 +40,4 @@ hugo list future [flags]
|
|||
### SEE ALSO
|
||||
* [hugo list](/commands/hugo_list/) - Listing out various types of content
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo new"
|
||||
slug: hugo_new
|
||||
url: /commands/hugo_new/
|
||||
|
@ -48,4 +48,4 @@ hugo new [path] [flags]
|
|||
* [hugo new site](/commands/hugo_new_site/) - Create a new site (skeleton)
|
||||
* [hugo new theme](/commands/hugo_new_theme/) - Create a new theme
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo new site"
|
||||
slug: hugo_new_site
|
||||
url: /commands/hugo_new_site/
|
||||
|
@ -43,4 +43,4 @@ hugo new site [path] [flags]
|
|||
### SEE ALSO
|
||||
* [hugo new](/commands/hugo_new/) - Create new content for your site
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo new theme"
|
||||
slug: hugo_new_theme
|
||||
url: /commands/hugo_new_theme/
|
||||
|
@ -42,4 +42,4 @@ hugo new theme [name] [flags]
|
|||
### SEE ALSO
|
||||
* [hugo new](/commands/hugo_new/) - Create new content for your site
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo server"
|
||||
slug: hugo_server
|
||||
url: /commands/hugo_server/
|
||||
|
@ -43,7 +43,8 @@ hugo server [flags]
|
|||
-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.)
|
||||
--disableFastRender enables full re-renders on changes
|
||||
--disableKinds strings disable different kind of pages (home, RSS etc.)
|
||||
--disableLiveReload watch without enabling live browser reload on rebuild
|
||||
--disableRSS do not build RSS files
|
||||
--disableSitemap do not build Sitemap file
|
||||
|
@ -67,6 +68,7 @@ hugo server [flags]
|
|||
-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
|
||||
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics
|
||||
-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/
|
||||
|
@ -88,4 +90,4 @@ hugo server [flags]
|
|||
### SEE ALSO
|
||||
* [hugo](/commands/hugo/) - hugo builds your site
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo undraft"
|
||||
slug: hugo_undraft
|
||||
url: /commands/hugo_undraft/
|
||||
|
@ -40,4 +40,4 @@ hugo undraft path/to/content [flags]
|
|||
### SEE ALSO
|
||||
* [hugo](/commands/hugo/) - hugo builds your site
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
date: 2017-09-26T21:11:49+02:00
|
||||
date: 2017-10-15T10:19:48+02:00
|
||||
title: "hugo version"
|
||||
slug: hugo_version
|
||||
url: /commands/hugo_version/
|
||||
|
@ -38,4 +38,4 @@ hugo version [flags]
|
|||
### SEE ALSO
|
||||
* [hugo](/commands/hugo/) - hugo builds your site
|
||||
|
||||
###### Auto generated by spf13/cobra on 26-Sep-2017
|
||||
###### Auto generated by spf13/cobra on 15-Oct-2017
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Cross References
|
||||
title: Links and Cross References
|
||||
description: Hugo makes it easy to link documents together.
|
||||
date: 2017-02-01
|
||||
publishdate: 2017-02-01
|
||||
|
|
|
@ -18,7 +18,7 @@ toc: true
|
|||
---
|
||||
|
||||
{{% note "Lazy Blogger"%}}
|
||||
If all you want is a simple menu for your sections, see the ["Section Menu for Lazy Bloggers" in Menu Templates](/templates/menu-templates/#section-menu-for-lazy-blogger).
|
||||
If all you want is a simple menu for your sections, see the ["Section Menu for Lazy Bloggers" in Menu Templates](/templates/menu-templates/#section-menu-for-lazy-bloggers).
|
||||
{{% /note %}}
|
||||
|
||||
You can do this:
|
||||
|
|
|
@ -22,21 +22,21 @@ If you want to continue to use Pygments (see below), set `pygmentsUseClassic=tru
|
|||
|
||||
The example below shows a simple code snippet from the Hugo source highlighted with the `highlight` shortcode. Note that the gohugo.io site is generated with `pygmentsUseClasses=true` (see [Generate Syntax Highlighter CSS](#generate-syntax-highlighter-css)).
|
||||
|
||||
* `linenos=inline` turns on line numbers. Note that the `inline` value only has an effect in Pygments.
|
||||
* `linenos=inline` or `linenos=table` (`table` will give copy-and-paste friendly code blocks) turns on line numbers.
|
||||
* `hl_lines` lists a set of line numbers or line number ranges to be highlighted. Note that the hyphen range syntax is only supported for Chroma.
|
||||
* `linenostart=199` starts the line number count from 199.
|
||||
|
||||
With that, this:
|
||||
|
||||
```
|
||||
{{</* highlight go "linenos=inline,hl_lines=8 15-17,linenostart=199" */>}}
|
||||
{{</* highlight go "linenos=table,hl_lines=8 15-17,linenostart=199" */>}}
|
||||
// ... code
|
||||
{{</* / highlight */>}}
|
||||
```
|
||||
|
||||
Gives this:
|
||||
|
||||
{{< highlight go "linenos=inline,hl_lines=8 15-17,linenostart=199" >}}
|
||||
{{< highlight go "linenos=table,hl_lines=8 15-17,linenostart=199" >}}
|
||||
// GetTitleFunc returns a func that can be used to transform a string to
|
||||
// title case.
|
||||
//
|
||||
|
@ -106,7 +106,7 @@ The full set of supported options for Pygments is: `encoding`, `outencoding`, `n
|
|||
|
||||
## Generate Syntax Highlighter CSS
|
||||
|
||||
If you run with `pygmentsUseClassic=true` in your site config, you need a style sheet.
|
||||
If you run with `pygmentsUseClasses=true` in your site config, you need a style sheet.
|
||||
|
||||
You can generate one with Hugo:
|
||||
|
||||
|
|
|
@ -45,6 +45,10 @@ Hugo will take this Markdown and create a table of contents from `## Introductio
|
|||
|
||||
The built-in `.TableOfContents` variables outputs a `<nav id="TableOfContents">` element with a child `<ul>`, whose child `<li>` elements begin with any `<h1>`'s (i.e., `#` in markdown) inside your content.'
|
||||
|
||||
{{% note "Table of contents not available for MMark" %}}
|
||||
Hugo documents created in the [MMark](/content-management/formats/#mmark) Markdown dialect do not currently display TOCs. TOCs are, however, compatible with all other supported Markdown formats.
|
||||
{{% /note %}}
|
||||
|
||||
## Template Example: Basic TOC
|
||||
|
||||
The following is an example of a very basic [single page template][]:
|
||||
|
|
|
@ -11,7 +11,7 @@ menu:
|
|||
docs:
|
||||
parent: "functions"
|
||||
keywords: [cross references, anchors]
|
||||
signature: ["ref PAGE CONTENT"]
|
||||
signature: ["ref CONTENT"]
|
||||
workson: []
|
||||
hugoversion:
|
||||
relatedfuncs: [relref]
|
||||
|
@ -19,10 +19,10 @@ deprecated: false
|
|||
aliases: []
|
||||
---
|
||||
|
||||
`ref` and `relRef` look up a content page by relative path (`relref`) or logical name (`ref`) to return the permalink. Both functions require a `Page` object (usually satisfied with a "`.`"):
|
||||
`ref` and `relRef` look up a content page by relative path (`relref`) or logical name (`ref`) to return the permalink:
|
||||
|
||||
```
|
||||
{{ relref . "about.md" }}
|
||||
{{ ref "about.md" }}
|
||||
```
|
||||
|
||||
These functions are used in two of Hugo's built-in shortcodes. You can see basic usage examples of both `ref` and `relref` in the [shortcode documentation](/content-management/shortcodes/#ref-and-relref).
|
||||
|
|
|
@ -11,7 +11,7 @@ menu:
|
|||
docs:
|
||||
parent: "functions"
|
||||
keywords: [cross references, anchors]
|
||||
signature: ["relref PAGE CONTENT"]
|
||||
signature: ["relref CONTENT"]
|
||||
workson: []
|
||||
hugoversion:
|
||||
relatedfuncs: [relref]
|
||||
|
@ -19,10 +19,10 @@ deprecated: false
|
|||
aliases: []
|
||||
---
|
||||
|
||||
`ref` and `relRef` look up a content page by relative path (`relref`) or logical name (`ref`) to return the permalink. Both functions require a `Page` object (usually satisfied with a "`.`"):
|
||||
`ref` and `relRef` look up a content page by relative path (`relref`) or logical name (`ref`) to return the permalink:
|
||||
|
||||
```
|
||||
{{ relref . "about.md" }}
|
||||
{{ relref "about.md" }}
|
||||
```
|
||||
|
||||
These functions are used in two of Hugo's built-in shortcodes. You can see basic usage examples of both `ref` and `relref` in the [shortcode documentation](/content-management/shortcodes/#ref-and-relref).
|
||||
|
|
|
@ -34,10 +34,9 @@ In your `config` file, you can direct Hugo as to how you want your website rende
|
|||
|
||||
## YAML Configuration
|
||||
|
||||
The following is a typical example of a YAML configuration file. Note the document opens with 3 hyphens and closes with 3 periods. The values nested under `params:` will populate the [`.Site.Params`][] variable for use in [templates][]:
|
||||
The following is a typical example of a YAML configuration file. The values nested under `params:` will populate the [`.Site.Params`][] variable for use in [templates][]:
|
||||
|
||||
{{< code file="config.yml">}}
|
||||
---
|
||||
baseURL: "https://yoursite.example.com/"
|
||||
title: "My Hugo Site"
|
||||
footnoteReturnLinkContents: "↩"
|
||||
|
@ -51,7 +50,6 @@ params:
|
|||
- "foo1"
|
||||
- "foo2"
|
||||
SidebarRecentLimit: 5
|
||||
...
|
||||
{{< /code >}}
|
||||
|
||||
### All Variables, YAML
|
||||
|
@ -59,7 +57,6 @@ params:
|
|||
The following is the full list of Hugo-defined variables in an example YAML file. The values provided in this example represent the default values used by Hugo.
|
||||
|
||||
{{< code file="config.yml" download="config.yml" >}}
|
||||
---
|
||||
archetypeDir: "archetypes"
|
||||
# hostname (and path) to the root, e.g. http://spf13.com/
|
||||
baseURL: ""
|
||||
|
@ -174,14 +171,13 @@ watch: true
|
|||
taxonomies:
|
||||
- category: "categories"
|
||||
- tag: "tags"
|
||||
---
|
||||
{{< /code >}}
|
||||
|
||||
## TOML Configuration
|
||||
|
||||
The following is an example of a TOML configuration file. The values under `[params]` will populate the `.Site.Params` variable for use in [templates][]:
|
||||
|
||||
```
|
||||
{{< code file="config.toml">}}
|
||||
contentDir = "content"
|
||||
layoutDir = "layouts"
|
||||
publishDir = "public"
|
||||
|
@ -197,14 +193,13 @@ title = "My Hugo Site"
|
|||
[params]
|
||||
subtitle = "Hugo is Absurdly Fast!"
|
||||
author = "John Doe"
|
||||
```
|
||||
{{< /code >}}
|
||||
|
||||
### All Variables, TOML
|
||||
|
||||
The following is the full list of Hugo-defined variables in an example TOML file. The values provided in this example represent the default values used by Hugo.
|
||||
|
||||
{{< code file="config.toml" download="config.toml">}}
|
||||
+++
|
||||
archetypeDir = "archetypes"
|
||||
# hostname (and path) to the root, e.g. http://spf13.com/
|
||||
baseURL = ""
|
||||
|
@ -313,14 +308,18 @@ watch = true
|
|||
[taxonomies]
|
||||
category = "categories"
|
||||
tag = "tags"
|
||||
+++
|
||||
{{< /code >}}
|
||||
|
||||
{{% note %}}
|
||||
If you are developing your site on a \*nix machine, here is a handy shortcut for finding a configuration option from the command line:
|
||||
```
|
||||
~/sites/yourhugosite
|
||||
cd ~/sites/yourhugosite
|
||||
hugo config | grep emoji
|
||||
```
|
||||
|
||||
which shows output like
|
||||
|
||||
```
|
||||
enableemoji: true
|
||||
```
|
||||
{{% /note %}}
|
||||
|
|
|
@ -29,7 +29,7 @@ User-agent: *
|
|||
The [lookup order][lookup] for the `robots.txt` template is as follows:
|
||||
|
||||
* `/layouts/robots.txt`
|
||||
* `/themes/<THEME>/layout/robots.txt`
|
||||
* `/themes/<THEME>/layouts/robots.txt`
|
||||
|
||||
{{% note %}}
|
||||
If you do not want Hugo to create a default `robots.txt` or leverage the `robots.txt` template, you can hand code your own and place the file in `static`. Remember that everything in the [static directory](/getting-started/directory-structure/) is copied over as-is when Hugo builds your site.
|
||||
|
|
|
@ -27,6 +27,7 @@ The following starter kits are developed by active members of the Hugo community
|
|||
* [GOHUGO AMP][]. GoHugo AMP is a starter theme that aims to make it easy to adopt [Google's AMP Project][amp]. The starter kit comes with 40+ shortcodes and partials plus automatic structured data. The project also includes a [separate site with extensive documentation][gohugodocs].
|
||||
* [Blaupause][]. Blaupause is a developer-friendly Hugo starter kit based on Gulp tasks. It comes ES6-ready with several helpers for SVG and fonts and basic structure for HTML, SCSS, and JavaScript.
|
||||
* [hugulp][]. hugulp is a tool to optimize the assets of a Hugo website. The main idea is to recreate the famous Ruby on Rails Asset Pipeline, which minifies, concatenates and fingerprints the assets used in your website.
|
||||
* [Atlas][]. Atlas is a Hugo boilerplate designed to speed up development with support for Netlify, Netlify CMS, Gulp, Linting, SCSS, ES6 & more. It's actively maintained and contributions are always welcome.
|
||||
|
||||
|
||||
[addkit]: https://github.com/gohugoio/hugo/edit/master/docs/content/tools/starter-kits.md
|
||||
|
@ -36,3 +37,4 @@ The following starter kits are developed by active members of the Hugo community
|
|||
[gohugodocs]: https://gohugo-amp.gohugohq.com/
|
||||
[hugulp]: https://github.com/jbrodriguez/hugulp
|
||||
[Victor Hugo]: https://github.com/netlify/victor-hugo
|
||||
[Atlas]: https://github.com/indigotree/atlas
|
|
@ -51,4 +51,8 @@ The `GitInfo` object contains the following fields:
|
|||
`.Subject`
|
||||
: commit message subject (e.g., `tpl: Add custom index function`)
|
||||
|
||||
## `.Lastmod`
|
||||
|
||||
If the `.GitInfo` feature is enabled, **and** if the `lastmod` field in the content's front matter is not set, `.Lastmod` (on `Page`) is fetched from Git i.e. `.GitInfo.AuthorDate`.
|
||||
|
||||
[configuration]: /getting-started/configuration/
|
||||
|
|
|
@ -79,7 +79,12 @@ See [`.Scratch`](/functions/scratch/) for page-scoped, writable variables.
|
|||
`config`.
|
||||
|
||||
`.Lastmod`
|
||||
: the date the content was last modified; `.Lastmod` pulls from the `lastmod` field in a content's front matter. If `lastmod` is not set, Hugo will default to the `date` field. See also `.ExpiryDate`, `.Date`, and `.PublishDate`.
|
||||
: the date the content was last modified. `.Lastmod` pulls from the `lastmod` field in a content's front matter.
|
||||
|
||||
- If `lastmod` is not set, and `.GitInfo` feature is disabled, the front matter `date` field will be used.
|
||||
- If `lastmod` is not set, and `.GitInfo` feature is enabled, `.GitInfo.AuthorDate` will be used instead.
|
||||
|
||||
See also `.ExpiryDate`, `.Date`, `.PublishDate`, and [`.GitInfo`][gitinfo].
|
||||
|
||||
`.LinkTitle`
|
||||
: access when creating links to the content. If set, Hugo will use the `linktitle` from the front matter before `title`.
|
||||
|
@ -266,3 +271,5 @@ The top-level key will be preferred. Therefore, the following method, when appli
|
|||
{{ $.Param "favorites.flavor" }}
|
||||
=> vanilla
|
||||
```
|
||||
|
||||
[gitinfo]: /variables/git/
|
||||
|
|
|
@ -352,6 +352,21 @@
|
|||
"tpl": {
|
||||
"funcs": {
|
||||
"cast": {
|
||||
"ToFloat": {
|
||||
"Description": "ToFloat converts the given value to a float.",
|
||||
"Args": [
|
||||
"v"
|
||||
],
|
||||
"Aliases": [
|
||||
"float"
|
||||
],
|
||||
"Examples": [
|
||||
[
|
||||
"{{ \"1234\" | float | printf \"%T\" }}",
|
||||
"float64"
|
||||
]
|
||||
]
|
||||
},
|
||||
"ToInt": {
|
||||
"Description": "ToInt converts the given value to an int.",
|
||||
"Args": [
|
||||
|
@ -888,6 +903,22 @@
|
|||
}
|
||||
},
|
||||
"fmt": {
|
||||
"Errorf": {
|
||||
"Description": "",
|
||||
"Args": [
|
||||
"format",
|
||||
"a"
|
||||
],
|
||||
"Aliases": [
|
||||
"errorf"
|
||||
],
|
||||
"Examples": [
|
||||
[
|
||||
"{{ errorf \"%s.\" \"failed\" }}",
|
||||
"failed."
|
||||
]
|
||||
]
|
||||
},
|
||||
"Print": {
|
||||
"Description": "Print returns string representation of the passed arguments.",
|
||||
"Args": [
|
||||
|
@ -920,7 +951,7 @@
|
|||
]
|
||||
},
|
||||
"Println": {
|
||||
"Description": "Print returns string representation of the passed arguments ending with a newline.",
|
||||
"Description": "Println returns string representation of the passed arguments ending with a newline.",
|
||||
"Args": [
|
||||
"a"
|
||||
],
|
||||
|
@ -1068,6 +1099,19 @@
|
|||
]
|
||||
]
|
||||
},
|
||||
"Ceil": {
|
||||
"Description": "Ceil returns the least integer value greater than or equal to x.",
|
||||
"Args": [
|
||||
"x"
|
||||
],
|
||||
"Aliases": null,
|
||||
"Examples": [
|
||||
[
|
||||
"{{math.Ceil 2.1}}",
|
||||
"3"
|
||||
]
|
||||
]
|
||||
},
|
||||
"Div": {
|
||||
"Description": "Div divides two numbers.",
|
||||
"Args": [
|
||||
|
@ -1084,6 +1128,19 @@
|
|||
]
|
||||
]
|
||||
},
|
||||
"Floor": {
|
||||
"Description": "Floor returns the greatest integer value less than or equal to x.",
|
||||
"Args": [
|
||||
"x"
|
||||
],
|
||||
"Aliases": null,
|
||||
"Examples": [
|
||||
[
|
||||
"{{math.Floor 1.9}}",
|
||||
"1"
|
||||
]
|
||||
]
|
||||
},
|
||||
"Log": {
|
||||
"Description": "Log returns the natural logarithm of a number.",
|
||||
"Args": [
|
||||
|
@ -1145,6 +1202,19 @@
|
|||
]
|
||||
]
|
||||
},
|
||||
"Round": {
|
||||
"Description": "Round returns the nearest integer, rounding half away from zero.",
|
||||
"Args": [
|
||||
"x"
|
||||
],
|
||||
"Aliases": null,
|
||||
"Examples": [
|
||||
[
|
||||
"{{math.Round 1.5}}",
|
||||
"2"
|
||||
]
|
||||
]
|
||||
},
|
||||
"Sub": {
|
||||
"Description": "Sub subtracts two numbers.",
|
||||
"Args": [
|
||||
|
@ -1163,6 +1233,21 @@
|
|||
}
|
||||
},
|
||||
"os": {
|
||||
"FileExists": {
|
||||
"Description": "FileExists checks whether a file exists under the given path.",
|
||||
"Args": [
|
||||
"i"
|
||||
],
|
||||
"Aliases": [
|
||||
"fileExists"
|
||||
],
|
||||
"Examples": [
|
||||
[
|
||||
"{{ fileExists \"foo.txt\" }}",
|
||||
"false"
|
||||
]
|
||||
]
|
||||
},
|
||||
"Getenv": {
|
||||
"Description": "Getenv retrieves the value of the environment variable named by the key.\nIt returns the value, which will be empty if the variable is not present.",
|
||||
"Args": [
|
||||
|
@ -1220,6 +1305,18 @@
|
|||
"\u003ctitle\u003eHugo Rocks!\u003c/title\u003e"
|
||||
]
|
||||
]
|
||||
},
|
||||
"IncludeCached": {
|
||||
"Description": "IncludeCached executes and caches partial templates. An optional variant\nstring parameter (a string slice actually, but be only use a variadic\nargument to make it optional) can be passed so that a given partial can have\nmultiple uses. The cache is created with name+variant as the key.",
|
||||
"Args": [
|
||||
"name",
|
||||
"context",
|
||||
"variant"
|
||||
],
|
||||
"Aliases": [
|
||||
"partialCached"
|
||||
],
|
||||
"Examples": []
|
||||
}
|
||||
},
|
||||
"safe": {
|
||||
|
@ -1838,6 +1935,12 @@
|
|||
],
|
||||
"Examples": []
|
||||
},
|
||||
"Parse": {
|
||||
"Description": "",
|
||||
"Args": null,
|
||||
"Aliases": null,
|
||||
"Examples": null
|
||||
},
|
||||
"Ref": {
|
||||
"Description": "Ref returns the absolute URL path to a given content item.",
|
||||
"Args": [
|
||||
|
|
BIN
docs/static/images/blog/hugo-30-poster.png
vendored
Normal file
BIN
docs/static/images/blog/hugo-30-poster.png
vendored
Normal file
Binary file not shown.
After Width: | Height: | Size: 120 KiB |
|
@ -44,7 +44,7 @@
|
|||
{{ block "main" . }}{{ end }}
|
||||
</main>
|
||||
|
||||
{{ block "footer" . }}{{ partial "site-footer.html" . }}{{ end }}
|
||||
{{ block "footer" . }}{{ partialCached "site-footer.html" . }}{{ end }}
|
||||
{{ block "scripts" . }}{{- partial "site-scripts.html" . -}}{{ end }}
|
||||
|
||||
</body>
|
||||
|
|
|
@ -29,7 +29,7 @@
|
|||
</div>
|
||||
|
||||
<span class="absolute mt1 mt2-l pr3 right-0 top-0">
|
||||
{{- partial "social-follow.html" . -}}
|
||||
{{- partialCached "social-follow.html" . -}}
|
||||
</span>
|
||||
|
||||
</div>
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
/* Background */ .chroma { background-color: #f0f0f0 }
|
||||
/* Error */ .chroma .err { }
|
||||
/* LineTableTD */ .chroma .lntd { ; vertical-align: top; padding: 0; margin: 0; border: 0; }
|
||||
/* LineTable */ .chroma .lntable { ; border-spacing: 0; padding: 0; margin: 0; border: 0; width: 100%; overflow: auto; display: block; }
|
||||
/* LineHighlight */ .chroma .hl { background-color: #ffffcc; display: block; width: 100% }
|
||||
/* LineNumbersTable */ .chroma .lnt { ; margin-right: 0.4em; padding: 0 0.4em 0 0.4em; display: block; }
|
||||
/* LineNumbers */ .chroma .ln { ; margin-right: 0.4em; padding: 0 0.4em 0 0.4em; }
|
||||
/* Keyword */ .chroma .k { color: #007020; font-weight: bold }
|
||||
/* KeywordConstant */ .chroma .kc { color: #007020; font-weight: bold }
|
||||
|
|
11
docs/themes/gohugoioTheme/src/css/_code.css
vendored
11
docs/themes/gohugoioTheme/src/css/_code.css
vendored
|
@ -1,3 +1,14 @@
|
|||
.chroma .lntable pre {
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
border: 0;
|
||||
}
|
||||
|
||||
.chroma .lntable pre code {
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
pre, .pre {
|
||||
overflow-x: auto;
|
||||
overflow-y: hidden;
|
||||
|
|
11696
docs/themes/gohugoioTheme/static/dist/app.bundle.js
vendored
11696
docs/themes/gohugoioTheme/static/dist/app.bundle.js
vendored
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Loading…
Reference in a new issue