mirror of
https://github.com/gohugoio/hugoDocs.git
synced 2025-09-10 10:24:50 -04:00
Refresh the documentation on staticDir config parameter
This commit is contained in:
parent
80ed4592b2
commit
79109b6858
@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Static Files
|
title: Static Files
|
||||||
description: "The `static` folder is where you place all your **static files**."
|
description: "Files that get served **statically** (as-is, no modification) on the site root."
|
||||||
date: 2017-11-18
|
date: 2017-11-18
|
||||||
categories: [content management]
|
categories: [content management]
|
||||||
keywords: [source, directories]
|
keywords: [source, directories]
|
||||||
@ -13,36 +13,58 @@ aliases: [/static-files]
|
|||||||
toc: true
|
toc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
The `static` folder is where you place all your **static files**, e.g. stylesheets, JavaScript, images etc.
|
By default, the `static/` directory in the site project is used for
|
||||||
|
all **static files** (e.g. stylesheets, JavaScript, images).
|
||||||
|
|
||||||
You can set the name of the static folder to use in your configuration file. From **Hugo 0.31** you can configure as many static directories as you need. All the files in all the static directories will form a union filesystem.
|
Hugo can be configured to look into a different directory, or even
|
||||||
|
**multiple directories** for such static files by configuring the
|
||||||
|
`staticDir` parameter in the [site config][]. All the files in all the
|
||||||
|
static directories will form a union filesystem.
|
||||||
|
|
||||||
Example:
|
This union filesystem will be served from your site root. So a file
|
||||||
|
`<SITE PROJECT>/static/me.png` will be accessible as
|
||||||
|
`<MY_BASEURL>/me.png`.
|
||||||
|
|
||||||
|
Here's an example of setting `staticDir` and `staticDir2` for a
|
||||||
|
multi-language site:
|
||||||
|
|
||||||
{{< code-toggle copy="false" file="config" >}}
|
{{< code-toggle copy="false" file="config" >}}
|
||||||
staticDir = ["static1", "static2"]
|
staticDir = ["static1", "static2"]
|
||||||
[languages]
|
|
||||||
[languages.no]
|
|
||||||
staticDir = ["staticDir_override", "static_no"]
|
|
||||||
baseURL = "https://example.no"
|
|
||||||
languageName = "Norsk"
|
|
||||||
weight = 1
|
|
||||||
title = "På norsk"
|
|
||||||
|
|
||||||
|
[languages]
|
||||||
[languages.en]
|
[languages.en]
|
||||||
staticDir2 = "static_en"
|
staticDir2 = "static_en"
|
||||||
baseURL = "https://example.com"
|
baseURL = "https://example.com"
|
||||||
languageName = "English"
|
languageName = "English"
|
||||||
weight = 2
|
weight = 2
|
||||||
title = "In English"
|
title = "In English"
|
||||||
|
[languages.no]
|
||||||
|
staticDir = ["staticDir_override", "static_no"]
|
||||||
|
baseURL = "https://example.no"
|
||||||
|
languageName = "Norsk"
|
||||||
|
weight = 1
|
||||||
|
title = "På norsk"
|
||||||
{{</ code-toggle >}}
|
{{</ code-toggle >}}
|
||||||
|
|
||||||
In the above, with no theme used:
|
In the above, with no theme used:
|
||||||
|
|
||||||
* The English site will get its static files as a union of "static1", "static2" and "static_en". On file duplicates, the right-most version will win.
|
- The English site will get its static files as a union of "static1",
|
||||||
* The Norwegian site will get its static files as a union of "staticDir_override" and "static_no".
|
"static2" and "static_en". On file duplicates, the right-most
|
||||||
|
version will win.
|
||||||
|
- The Norwegian site will get its static files as a union of
|
||||||
|
"staticDir_override" and "static_no".
|
||||||
|
|
||||||
**Note:** The `2` `static2` (can be a number between 0 and 10) is added to tell Hugo that you want to **add** this directory to the global set of static directories. Using `staticDir` on the language level would replace the global value.
|
Note 1
|
||||||
|
: The **2** (can be a number between 0 and 10) in `staticDir2` is
|
||||||
|
added to tell Hugo that you want to **add** this directory to the
|
||||||
|
global set of static directories defined using `staticDir`. Using
|
||||||
|
`staticDir` on the language level would replace the global value (as
|
||||||
|
can be seen in the Norwegian site case).
|
||||||
|
|
||||||
|
Note 2
|
||||||
|
: The example above is a [multihost setup][]. In a regular setup, all
|
||||||
|
the static directories will be available to all sites.
|
||||||
|
|
||||||
|
|
||||||
**Note:** The example above is a [multihost setup](/content-management/multilingual/#configure-multilingual-multihost). In a regular setup, all the static directories will be available to all sites.
|
[site config]: /getting-started/configuration/#all-configuration-settings
|
||||||
|
[multihost setup]: /content-management/multilingual/#configure-multilingual-multihost
|
||||||
|
@ -193,7 +193,7 @@ sitemap
|
|||||||
: Default [sitemap configuration](/templates/sitemap-template/#configure-sitemap-xml).
|
: Default [sitemap configuration](/templates/sitemap-template/#configure-sitemap-xml).
|
||||||
|
|
||||||
staticDir ("static")
|
staticDir ("static")
|
||||||
: Relative directory from where Hugo reads static files.
|
: A directory or a list of directories from where Hugo reads [static files][static-files].
|
||||||
|
|
||||||
stepAnalysis (false)
|
stepAnalysis (false)
|
||||||
: Display memory and timing of different steps of the program.
|
: Display memory and timing of different steps of the program.
|
||||||
@ -405,3 +405,4 @@ Hugo v0.20 introduced the ability to render your content to multiple output form
|
|||||||
[templates]: /templates/
|
[templates]: /templates/
|
||||||
[toml]: https://github.com/toml-lang/toml
|
[toml]: https://github.com/toml-lang/toml
|
||||||
[yaml]: http://yaml.org/spec/
|
[yaml]: http://yaml.org/spec/
|
||||||
|
[static-files]: /content-management/static-files/
|
||||||
|
Loading…
x
Reference in New Issue
Block a user