mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
5e078383a7
49809a03 Merge commit '20a631b4964fc0ab9137cce1e41774cbc17de044' 20a631b4 Squashed 'themes/gohugoioTheme/' changes from b8202f539..dafc91ff1 8b58f565 Re-generate CLI docs 4653a724 Add Netlify deployment badge 2d6246bc Remove some deprecated site variables e6777153 Improve Algolia Search Display Styling 1570999f Add missing "." in front of gitlab-ci.yaml example b922ae7d This adds documentation to the new configDir/Environment logic from .53 (#729) 7cff379f Correctly escape multi-word taxonomy terms in example 2dfeeda4 fix typo by removing stray paren 0870bd9a Fix typo in `paginate` description 91e8be85 Fixes https://github.com/gohugoio/hugo/issues/5609 c1db65ec Make the dummy URL more obvious b4589ff0 Fix a link b73dcb9a Consistently use "posts" as section name in examples 7a56abbc Format definitions a9c6fd9b Minor clarification over the last commit 5c86bdc8 Add alternative instructions for Quick Start for non-git users dafe7ee9 Add Visual Studio Code plug-ins 110ed19e Update HUGO_VERSION 2abd031a Update page.md b332f7b9 Update page.md f5a8c9d4 Update static-files.md 6d0c155c Add note about relative protocol URLs a13751ac Theme Warning: Remove note about unquoted URLs 4c8f7d68 Incorporate feedback 6f2b9cf0 Update Creating Themes Warning 40d88d98 Fix ToC example to use binary true/false 4a11f3f1 Fix typo 2dbfc0a4 Fix a typo in taxonomies d63790ef Do not mark UndocumentedFeature issues as stale d7aff095 Regenerate docs.json 71c0826f Update transform.Unmarshal.md git-subtree-dir: docs git-subtree-split: 49809a038b2691637bab7f3f2e385dde654a88b8
70 lines
2.4 KiB
Markdown
70 lines
2.4 KiB
Markdown
---
|
|
title: Static Files
|
|
description: "Files that get served **statically** (as-is, no modification) on the site root."
|
|
date: 2017-11-18
|
|
categories: [content management]
|
|
keywords: [source, directories]
|
|
menu:
|
|
docs:
|
|
parent: "content-management"
|
|
weight: 130
|
|
weight: 130 #rem
|
|
aliases: [/static-files]
|
|
toc: true
|
|
---
|
|
|
|
By default, the `static/` directory in the site project is used for
|
|
all **static files** (e.g. stylesheets, JavaScript, images). The static files are served on the site root path (eg. if you have the file `static/image.png` you can access it using `http://{server-url}/image.png`, to include it in a document you can use `![Example image](/image.png) )`.
|
|
|
|
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.
|
|
|
|
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" >}}
|
|
staticDir = ["static1", "static2"]
|
|
|
|
[languages]
|
|
[languages.en]
|
|
staticDir2 = "static_en"
|
|
baseURL = "https://example.com"
|
|
languageName = "English"
|
|
weight = 2
|
|
title = "In English"
|
|
[languages.no]
|
|
staticDir = ["staticDir_override", "static_no"]
|
|
baseURL = "https://example.no"
|
|
languageName = "Norsk"
|
|
weight = 1
|
|
title = "På norsk"
|
|
{{</ code-toggle >}}
|
|
|
|
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 Norwegian site will get its static files as a union of
|
|
"staticDir_override" and "static_no".
|
|
|
|
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.
|
|
|
|
|
|
[site config]: /getting-started/configuration/#all-configuration-settings
|
|
[multihost setup]: /content-management/multilingual/#configure-multilingual-multihost
|