TheCloud/hugoDocs
1
0
Fork 0
mirror of https://github.com/gohugoio/hugoDocs.git synced 2025-09-17 08:07:29 -04:00
Code Issues Packages Projects Releases Wiki Activity

Sort config list

Browse Source
This commit is contained in:
Bjørn Erik Pedersen 2018-03-01 18:00:13 +01:00
parent 5cb8ceade5
commit f1c7aa5684
No known key found for this signature in database
GPG Key ID: 330E6E2BD4859D8F
1 changed files with 25 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
content/getting-started/configuration.md
View File

@ -23,7 +23,6 @@ toc: true
The following is the full list of Hugo-defined variables with its default value in parens. The following is the full list of Hugo-defined variables with its default value in parens.
archetypeDir ("archetypes") archetypeDir ("archetypes")
: The directory where Hugo finds archetype files (content templates). : The directory where Hugo finds archetype files (content templates).
@ -33,14 +32,11 @@ baseURL
buildDrafts (false) buildDrafts (false)
: Include drafts when building. : Include drafts when building.
buildFuture (false)
: Include content with publishdate in the future.
buildExpired (false) buildExpired (false)
: Include content already expired. : Include content already expired.
relativeURLs (false) buildFuture (false)
: Enable this to make all relative URLs relative to content root. Note that this does not affect absolute URLs. : Include content with publishdate in the future.
canonifyURLs (false) canonifyURLs (false)
: Enable to turn relative URLs into absolute. : Enable to turn relative URLs into absolute.
@ -60,30 +56,30 @@ defaultContentLanguage ("en")
defaultContentLanguageInSubdir (false) defaultContentLanguageInSubdir (false)
: Renders the default content language in subdir, e.g. /en/. The root directory / will redirect to /en/. : Renders the default content language in subdir, e.g. /en/. The root directory / will redirect to /en/.
disableLiveReload (false)
: Turn off automatic live reloading of browser window.
enableGitInfo (false)
: If the Hugo site is versioned by Git, you will then get a `.GitInfo` object per page, and `Lastmod` will get updated by the last commit date for content.
enableRobotsTXT (false)
: When enabled, Hugo will generate a `robots.txt` file.
disableHugoGeneratorInject (false) disableHugoGeneratorInject (false)
: Hugo will, by default, inject a generator meta tag in the HTML head on the _home page only_. You can turn it off, but we would really appreciate if you don't, as this is a good way to watch Hugo's popularity on the rise. : Hugo will, by default, inject a generator meta tag in the HTML head on the _home page only_. You can turn it off, but we would really appreciate if you don't, as this is a good way to watch Hugo's popularity on the rise.
disableKinds ([]) disableKinds ([])
: Allows you to disable all page types and will render nothing related to 'kind'. Allowed values are "page", "home", "section", "taxonomy", "taxonomyTerm", "RSS", "sitemap", "robotsTXT", "404". : Allows you to disable all page types and will render nothing related to 'kind'. Allowed values are "page", "home", "section", "taxonomy", "taxonomyTerm", "RSS", "sitemap", "robotsTXT", "404".
disableLiveReload (false)
: Turn off automatic live reloading of browser window.
disablePathToLower (false) disablePathToLower (false)
: Do not make the url/path to lowercase. : Do not make the url/path to lowercase.
enableEmoji (false) enableEmoji (false)
: Enable Emoji emoticons support for page content; see emoji-cheat-sheet.com. : Enable Emoji emoticons support for page content; see emoji-cheat-sheet.com.
enableGitInfo (false)
: If the Hugo site is versioned by Git, you will then get a `.GitInfo` object per page, and `Lastmod` will get updated by the last commit date for content.
enableMissingTranslationPlaceholders (false) enableMissingTranslationPlaceholders (false)
: Show a placeholder instead of the default value or an empty string if a translation is missing : Show a placeholder instead of the default value or an empty string if a translation is missing
enableRobotsTXT (false)
: When enabled, Hugo will generate a `robots.txt` file.
footnoteAnchorPrefix ("") footnoteAnchorPrefix ("")
: A prefix for your footnote anchors. : A prefix for your footnote anchors.
@ -99,9 +95,6 @@ hasCJKLanguage (false)
languageCode ("") languageCode ("")
: The site's language code. : The site's language code.
summaryLength (70)
: The length of text to show in a `.Summary`.
layoutDir ("layouts") layoutDir ("layouts")
: The directory from where Hugo reads layouts (templates). : The directory from where Hugo reads layouts (templates).
@ -111,9 +104,6 @@ log (false)
logFile ("") logFile ("")
: Log File path (if set, logging enabled automatically). : Log File path (if set, logging enabled automatically).
rssLimit (15)
: Maximum number of items in the RSS feed.
metaDataFormat ("toml") metaDataFormat ("toml")
: "toml","yaml", or "json" : "toml","yaml", or "json"
@ -153,6 +143,12 @@ pygmentsStyle ("monokai")
pygmentsUseClasses (false) pygmentsUseClasses (false)
: Enable to use external CSS for code highlighting. : Enable to use external CSS for code highlighting.
relativeURLs (false)
: Enable this to make all relative URLs relative to content root. Note that this does not affect absolute URLs.
rssLimit (15)
: Maximum number of items in the RSS feed.
sectionPagesMenu ("")( sectionPagesMenu ("")(
: See ["Section Menu for Lazy Bloggers"](/templates/menu-templates/#section-menu-for-lazy-bloggers). : See ["Section Menu for Lazy Bloggers"](/templates/menu-templates/#section-menu-for-lazy-bloggers).
@ -165,12 +161,18 @@ staticDir ("static")
stepAnalysis (false) stepAnalysis (false)
: Display memory and timing of different steps of the program. : Display memory and timing of different steps of the program.
themesDir ("themes") summaryLength (70)
: The directory where Hugo reads the themes from. : The length of text to show in a `.Summary`.
taxonomies
: See [Configure Taxonomies](content-management/taxonomies#configure-taxonomies)
theme ("") theme ("")
: Theme to use (located by default in /themes/THEMENAME/) : Theme to use (located by default in /themes/THEMENAME/)
themesDir ("themes")
: The directory where Hugo reads the themes from.
title ("") title ("")
: Site title. : Site title.
@ -186,10 +188,6 @@ verboseLog (false)
watch (false) watch (false)
: Watch filesystem for changes and recreate as needed. : Watch filesystem for changes and recreate as needed.
taxonomies
: See [Configure Taxonomies](content-management/taxonomies#configure-taxonomies)
{{% note %}} {{% 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: If you are developing your site on a \*nix machine, here is a handy shortcut for finding a configuration option from the command line:
``` ```