github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-28 23:52:04 -05:00
Code Issues Projects Releases Packages Wiki Activity

docs: Document the new file cache

Browse source 
See #5404
This commit is contained in:
Bjørn Erik Pedersen 2018-11-13 14:29:45 +01:00
parent f7aeaa6129
commit abeeff1325
No known key found for this signature in database
GPG key ID: 330E6E2BD4859D8F
1 changed files with 41 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
docs/content/en/getting-started/configuration.md
View file

@ -62,6 +62,9 @@ buildExpired (false)
buildFuture (false) buildFuture (false)
: Include content with publishdate in the future. : Include content with publishdate in the future.
caches
: See [Configure File Caches](#configure-file-caches)
canonifyURLs (false) canonifyURLs (false)
: Enable to turn relative URLs into absolute. : Enable to turn relative URLs into absolute.
@ -403,6 +406,44 @@ However, if you have specific needs with respect to Markdown, Hugo exposes some
Hugo v0.20 introduced the ability to render your content to multiple output formats (e.g., to JSON, AMP html, or CSV). See [Output Formats][] for information on how to add these values to your Hugo project's configuration file. Hugo v0.20 introduced the ability to render your content to multiple output formats (e.g., to JSON, AMP html, or CSV). See [Output Formats][] for information on how to add these values to your Hugo project's configuration file.
## Configure File Caches
Since Hugo 0.52 you can configure more than just the `cacheDir`. This is the default configuration:
```toml
[caches]
[caches.getjson]
dir = ":cacheDir"
maxAge = -1
[caches.getcsv]
dir = ":cacheDir"
maxAge = -1
[caches.images]
dir = ":resourceDir/_gen"
maxAge = -1
[caches.assets]
dir = ":resourceDir/_gen"
maxAge = -1
```
You can override any of these cache setting in your own `config.toml`.
### The keywords explained
:cacheDir
: This is the value of the `cacheDir` config option if set (can also be set via OS env variable `HUGO_CACHEDIR`). It will fall back to `/opt/build/cache/hugo_cache/` on Netlify, or a `hugo_cache` directory below the OS temp dir for the others. This means that if you run your builds on Netlify, all caches configured with `:cacheDir` will be saved and restored on the next build. For other CI vendors, please read their documentation. For an CircleCI example, see [this configuration](https://github.com/bep/hugo-sass-test/blob/6c3960a8f4b90e8938228688bc49bdcdd6b2d99e/.circleci/config.yml).
:resourceDir
: This is the value of the `resourceDir` config option.
maxAge
: This is the time in seconds before a cache entry will be evicted, -1 means forever and 0 effectively turns that particular cache off.
dir
: The absolute path to where the files for this cache will be stored. Allowed starting placeholders are `:cacheDir` and `:resourceDir` (see above).
## Configuration Format Specs ## Configuration Format Specs
* [TOML Spec][toml] * [TOML Spec][toml]