mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
368 lines
13 KiB
Markdown
368 lines
13 KiB
Markdown
---
|
|
aliases:
|
|
- /doc/configuration/
|
|
lastmod: 2015-12-08
|
|
date: 2013-07-01
|
|
linktitle: Configuration
|
|
menu:
|
|
main:
|
|
parent: getting started
|
|
next: /overview/source-directory
|
|
notoc: true
|
|
prev: /overview/usage
|
|
title: Configuring Hugo
|
|
weight: 40
|
|
---
|
|
|
|
The directory structure and templates provide the majority of the
|
|
configuration for a site. In fact, a config file isn't even needed for many
|
|
websites since the defaults follow commonly used patterns.
|
|
|
|
Hugo expects to find the config file in the root of the source directory and
|
|
will look there first for a `config.toml` file. If none is present, it will
|
|
then look for a `config.yaml` file, followed by a `config.json` file.
|
|
|
|
The config file is a site-wide config. The config file provides directions to
|
|
hugo on how to build the site as well as site-wide parameters and menus.
|
|
|
|
Site configuration can also be set as environment variables in your operating system. The command below will work on *nix systems and overrides the site title. Note that all the variable names must be prefixed with "HUGO_".
|
|
|
|
```bash
|
|
env HUGO_TITLE="Some Title" hugo
|
|
```
|
|
|
|
## Examples
|
|
|
|
The following is an example of a typical yaml config file:
|
|
|
|
---
|
|
baseurl: "http://yoursite.example.com/"
|
|
...
|
|
|
|
The following is an example of a toml config file with some of the default values.
|
|
Values under `[params]` will populate the `.Site.Params` variable for use in templates:
|
|
|
|
contentdir = "content"
|
|
layoutdir = "layouts"
|
|
publishdir = "public"
|
|
builddrafts = false
|
|
baseurl = "http://yoursite.example.com/"
|
|
canonifyurls = true
|
|
|
|
[taxonomies]
|
|
category = "categories"
|
|
tag = "tags"
|
|
|
|
[params]
|
|
description = "Tesla's Awesome Hugo Site"
|
|
author = "Nikola Tesla"
|
|
|
|
Here is a yaml configuration file which sets a few more options:
|
|
|
|
---
|
|
baseurl: "http://yoursite.example.com/"
|
|
title: "Yoyodyne Widget Blogging"
|
|
footnotereturnlinkcontents: "↩"
|
|
permalinks:
|
|
post: /:year/:month/:title/
|
|
params:
|
|
Subtitle: "Spinning the cogs in the widgets"
|
|
AuthorName: "John Doe"
|
|
GitHubUser: "spf13"
|
|
ListOfFoo:
|
|
- "foo1"
|
|
- "foo2"
|
|
SidebarRecentLimit: 5
|
|
...
|
|
|
|
## Configuration variables
|
|
|
|
Following is a list of Hugo-defined variables that you can configure and their current default values:
|
|
|
|
---
|
|
archetypedir: "archetype"
|
|
# hostname (and path) to the root, e.g. http://spf13.com/
|
|
baseURL: ""
|
|
# include content marked as draft
|
|
buildDrafts: false
|
|
# include content with publishdate in the future
|
|
buildFuture: false
|
|
# include content already expired
|
|
buildExpired: false
|
|
# enable this to make all relative URLs relative to content root. Note that this does not affect absolute URLs.
|
|
relativeURLs: false
|
|
canonifyURLs: false
|
|
# config file (default is path/config.yaml|json|toml)
|
|
config: "config.toml"
|
|
contentdir: "content"
|
|
dataDir: "data"
|
|
defaultExtension: "html"
|
|
defaultLayout: "post"
|
|
disableLiveReload: false
|
|
# Do not build RSS files
|
|
disableRSS: false
|
|
# Do not build Sitemap file
|
|
disableSitemap: false
|
|
# Build robots.txt file
|
|
enableRobotsTXT: false
|
|
# Do not render 404 page
|
|
disable404: false
|
|
# Do not inject generator meta tag on homepage
|
|
disableHugoGeneratorInject: false
|
|
# edit new content with this editor, if provided
|
|
editor: ""
|
|
# Enable Emoji emoticons support for page content.
|
|
# See www.emoji-cheat-sheet.com
|
|
enableEmoji: false
|
|
footnoteAnchorPrefix: ""
|
|
footnoteReturnLinkContents: ""
|
|
# google analytics tracking id
|
|
googleAnalytics: ""
|
|
languageCode: ""
|
|
layoutdir: "layouts"
|
|
# Enable Logging
|
|
log: false
|
|
# Log File path (if set, logging enabled automatically)
|
|
logFile: ""
|
|
# "yaml", "toml", "json"
|
|
metaDataFormat: "toml"
|
|
newContentEditor: ""
|
|
# Don't sync modification time of files
|
|
noTimes: false
|
|
paginate: 10
|
|
paginatePath: "page"
|
|
permalinks:
|
|
# Pluralize titles in lists using inflect
|
|
pluralizeListTitles: true
|
|
# Preserve special characters in taxonomy names ("Gérard Depardieu" vs "Gerard Depardieu")
|
|
preserveTaxonomyNames: false
|
|
# filesystem path to write files to
|
|
publishdir: "public"
|
|
# enables syntax guessing for code fences without specified language
|
|
pygmentsCodeFencesGuessSyntax: false
|
|
# color-codes for highlighting derived from this style
|
|
pygmentsStyle: "monokai"
|
|
# true: use pygments-css or false: color-codes directly
|
|
pygmentsUseClasses: false
|
|
# default sitemap configuration map
|
|
sitemap:
|
|
# filesystem path to read files relative from
|
|
source: ""
|
|
staticdir: "static"
|
|
# display memory and timing of different steps of the program
|
|
stepAnalysis: false
|
|
# theme to use (located by default in /themes/THEMENAME/)
|
|
themesdir = "themes"
|
|
theme: ""
|
|
title: ""
|
|
# if true, use /filename.html instead of /filename/
|
|
uglyURLs: false
|
|
# Do not make the url/path to lowercase
|
|
disablePathToLower: false
|
|
# if true, auto-detect Chinese/Japanese/Korean Languages in the content. (.Summary and .WordCount can work properly in CJKLanguage)
|
|
hasCJKLanguage: false
|
|
# verbose output
|
|
verbose: false
|
|
# verbose logging
|
|
verboseLog: false
|
|
# watch filesystem for changes and recreate as needed
|
|
watch: true
|
|
---
|
|
|
|
## Ignore files on build
|
|
|
|
The following inside `config.toml` will ignore files ending with `.foo` and `.boo` when building with `hugo`:
|
|
|
|
```
|
|
ignoreFiles = [ "\\.foo$", "\\.boo$" ]
|
|
```
|
|
|
|
The above is a list of Regular Expressions, but note the escaping of the `\` to make TOML happy.
|
|
|
|
|
|
|
|
## Configure Blackfriday rendering
|
|
|
|
[Blackfriday](https://github.com/russross/blackfriday) is the [Markdown](http://daringfireball.net/projects/markdown/) rendering engine used in Hugo. The Blackfriday configuration in Hugo is mostly a set of sane defaults that should fit most use cases.
|
|
|
|
But Hugo does expose some options---as listed in the table below, matched with the corresponding flag in the Blackfriday source ([html.go](https://github.com/russross/blackfriday/blob/master/html.go) and [markdown.go](https://github.com/russross/blackfriday/blob/master/markdown.go)):
|
|
|
|
<table class="table table-bordered">
|
|
<thead>
|
|
<tr>
|
|
<th>Flag</th><th>Default</th><th>Blackfriday flag</th>
|
|
</tr>
|
|
</thead>
|
|
|
|
<tbody>
|
|
<tr>
|
|
<td><code><strong>smartypants</strong></code></td>
|
|
<td><code>true</code></td>
|
|
<td><code>HTML_USE_SMARTYPANTS</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="purpose-title">Purpose:</td>
|
|
<td class="purpose-description" colspan="2">Enable/Disable smart punctuation substitutions such as smart quotes, smart dashes, etc.
|
|
May be fine-tuned with the <code>angledQuotes</code>, <code>fractions</code>, <code>smartDashes</code> and <code>latexDashes</code> flags below.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><code><strong>angledQuotes</strong></code></td>
|
|
<td><code>false</code></td>
|
|
<td><code>HTML_SMARTYPANTS_ANGLED_QUOTES</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="purpose-title">Purpose:</td>
|
|
<td class="purpose-description" colspan="2">Enable/Disable smart angled double quotes.<br>
|
|
<small><strong>Example:</strong> <code>"Hugo"</code> renders to «Hugo» instead of “Hugo”.</small></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><code><strong>fractions</strong></code></td>
|
|
<td><code>true</code></td>
|
|
<td><code>HTML_SMARTYPANTS_FRACTIONS</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="purpose-title">Purpose:</td>
|
|
<td class="purpose-description" colspan="2">Enable/Disable smart fractions.<br>
|
|
<small><strong>Example:</strong> <code>5/12</code> renders to <sup>5</sup>⁄<sub>12</sub> (<code><sup>5</sup>&frasl;<sub>12</sub></code>)<br>
|
|
<strong>Caveat:</strong> Even with <code>fractions = false</code>,
|
|
Blackfriday would still convert 1/2, 1/4 and 3/4 to ½ (<code>&frac12;</code>),
|
|
¼ (<code>&frac14;</code>) and ¾ (<code>&frac34;</code>) respectively,
|
|
but only these three.</small></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><code><strong>smartDashes</strong></code></td>
|
|
<td><code>true</code></td>
|
|
<td><code>HTML_SMARTYPANTS_DASHES</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="purpose-title">Purpose:</td>
|
|
<td class="purpose-description" colspan="2">Enable/Disable smart dashes, i.e. turning hyphens into en dash or em dash.<br>
|
|
Its behavior can be modified with the <code>latexDashes</code> flag listed below.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><code><strong>latexDashes</strong></code></td>
|
|
<td><code>true</code></td>
|
|
<td><code>HTML_SMARTYPANTS_LATEX_DASHES</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="purpose-title">Purpose:</td>
|
|
<td class="purpose-description" colspan="2">Choose between LaTeX-style smart dashes and “conventional” smart dashes.<br>
|
|
<strong>If <code>true</code>,</strong> <code>--</code> is translated into “–” (<code>&ndash;</code>), and <code>---</code> is translated into “—” (<code>&mdash;</code>).<br>
|
|
<strong>If <code>false</code>,</strong> <code>--</code> is translated into “—” (<code>&mdash;</code>), whereas a <em>spaced</em> single hyphen between two words is turned into an en dash, e.g. <code>12 June - 3 July</code> becomes <code>12 June &ndash; 3 July</code>.</td>
|
|
</tr>
|
|
|
|
<tr style="height: 0.5em;"></tr>
|
|
|
|
<tr>
|
|
<td><code><strong>hrefTargetBlank</strong></code></td>
|
|
<td><code>false</code></td>
|
|
<td><code>HTML_HREF_TARGET_BLANK</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="purpose-title">Purpose:</td>
|
|
<td class="purpose-description" colspan="2">Open external links in a new window/tab.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><code><strong>plainIDAnchors</strong></code></td>
|
|
<td><code>true</code></td>
|
|
<td><code>FootnoteAnchorPrefix</code> and <code>HeaderIDSuffix</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="purpose-title">Purpose:</td>
|
|
<td class="purpose-description" colspan="2">If <code>true</code>, then header and footnote IDs are generated without the document ID.<br>
|
|
<small><strong>Example:</strong> <code>#my-header</code> instead of <code>#my-header:bec3ed8ba720b9073ab75abcf3ba5d97</code>.</small></td>
|
|
</tr>
|
|
|
|
<tr style="height: 0.5em;"></tr>
|
|
|
|
<tr>
|
|
<td><code><strong>extensions</strong></code></td>
|
|
<td><code>[]</code></td>
|
|
<td><code>EXTENSION_*</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="purpose-title">Purpose:</td>
|
|
<td class="purpose-description" colspan="2">Use non-default additional extensions.<br>
|
|
<small><strong>Example:</strong> Add <code>"hardLineBreak"</code> to use <code>EXTENSION_HARD_LINE_BREAK</code>.</small></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><code><strong>extensionsmask</strong></code></td>
|
|
<td><code>[]</code></td>
|
|
<td><code>EXTENSION_*</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="purpose-title">Purpose:</td>
|
|
<td class="purpose-description" colspan="2">Extensions in this option won't be loaded.<br>
|
|
<small><strong>Example:</strong> Add <code>"autoHeaderIds"</code> to disable <code>EXTENSION_AUTO_HEADER_IDS</code>.</small></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><code><strong>sourceRelativeLinksEval</strong></code></td>
|
|
<td><code>false</code></td>
|
|
<td><code>none</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="purpose-title">Purpose:</td>
|
|
<td class="purpose-description" colspan="2">Source file based relative linking (a la Github).<br>
|
|
Relative links to markdown and static files within a page will be evaluated relative to the
|
|
location of that page, and then converted to html links during rendering. For example,
|
|
`[example](../other/page.md)` in `content/total/overview.md` will be linked to
|
|
`content/other/overview.md`, and then rendered to `/other/overview/` in the HTML output.
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><code><strong>sourceRelativeLinksProjectFolder</strong></code></td>
|
|
<td><code>"/docs/content"</code></td>
|
|
<td><code>none</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="purpose-title">Purpose:</td>
|
|
<td class="purpose-description" colspan="2">Source file based relative linking Hugo Project sub-folder.<br>
|
|
When `sourceRelativeLinksEval` is enabled, source level paths may contain an absolute respository path to the
|
|
markdown or static file which needs to be removed before trying to match it with the intended link.
|
|
For example, if your documentation is in `/docs/content`, then
|
|
`[example](/docs/content/other/page.md)` in `/docs/content/total/overview.md` will be linked to
|
|
`/docs/content/other/overview.md`, and then rendered to `/other/overview/` in the HTML output.
|
|
</td>
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
**Notes**
|
|
|
|
1. These flags are **very case-sensitive** (as of Hugo v0.15)!
|
|
2. These flags must be grouped under the `blackfriday` key and can be set on **both site and page level**. If set on page, it will override the site setting. Example:
|
|
|
|
<table class="table">
|
|
<thead>
|
|
<tr>
|
|
<th>TOML</th><th>YAML</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr style="vertical-align: top;">
|
|
<td style="width: 50%;"><pre><code>[blackfriday]
|
|
angledQuotes = true
|
|
fractions = false
|
|
plainIDAnchors = true
|
|
extensions = ["hardLineBreak"]
|
|
</code></pre></td>
|
|
<td><pre><code>blackfriday:
|
|
angledQuotes: true
|
|
fractions: false
|
|
plainIDAnchors: true
|
|
extensions:
|
|
- hardLineBreak
|
|
</code></pre></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|