![Bjørn Erik Pedersen](/assets/img/avatar_default.png)
c43daf45f Update build-options.md 3ebbfedd4 Build options: Improve readability 5091bf6a0 Improve safeHTMLAttr explanation b64cbce2e Fix description of collections.Apply 6ea264b9c netlify: Hugo 0.115.4 b42e7c542 Revert "config: Remove disableLiveReload" 35ce2290e Remove excess spaces in configuration docs 2edf761de Update listed titleCaseStyle default value 887f6fb97 config: Remove disableLiveReload c9f49fb26 Fix typo 37d8569ac Remove tools associated with Atom 871d11b72 Fix URL in postprocess docs bbb17d29f Update GitLab workflow bc53ea5ce Use sentence-style capitalization for headings 7ca578786 netlify: Hugo 0.115.3 c5e010bd0 Merge branch 'tempv0.115.3' c885604bf Remove starter kits page 4c0fe269e Update mention of Netlify CMS to Decap CMS 05067175c Consistently use file name instead of filename 763dd6404 Improve multilingual config example and descriptions e5aa61ec5 Use lowercase when referring to front matter (#2132) 7ba3d0c72 docs: Refresh docs.json de8bddedf Update description of timeout configuration value e1245d9f8 netify: Hugo 0.115.2 153a36bdf Merge branch 'tempv0.115.2' 707cec754 Fix typo in figure example in shortcodes.md 128cbe1e5 Improve taxonomy template examples 4e743ec36 Improve highlight function example f96fa6805 transpile sass: Fixes typo e4a8a21f7 Compile Sass to CSS, not SCSS c1538bd00 docs: Regenerate CLI docs bd4e33436 Add titleCaseStyle none and firstupper 6ff93d478 Update quick-start.md 5c6653cb1 Update build config examples and explanation 1458d9a43 Remove the `url` parameter 6a1e92044 netlify: Hugo 0.115.1 a9d5d6f2f Merge branch 'tempv0.115.1' 4c4882384 docs: Regen docs helper d1aa1c1f5 Add link to PowerShell vs Windows PowerShell documentation 6e3b70c21 Fix link to Git installation instructions 4f8a9ca38 Clarify resources.Copy arguments ee86dd121 Update theme dc7c305cf Update theme 60c23920b Clarify caching for resources.FromString (#2120) 5bf2fef6d netlify: Hugo 0.115.0 46bde87c5 Merge branch 'tempv0.115.0' 42cc48c16 Specify target path caching for resources.ExecuteAsTemplate (#2027) a54bf4cd0 Correct the sample code of mermaid (#2119) 8c49b06fc docs: Update permalinks documentation a4818d99b Page bundles: link to info about single vs. list page templates (#2116) 3fc7744d7 snap: Document removable media access dbd08f58a Update theme df5b88633 netlify: Hugo 0.114.1 6b859834a Fix typo 9ec92cf68 Improve Dart Sass example for Netlify 2d294ece9 Add Dart Sass installation and usage documentation 4c6b77d6c Fix placement of curly braces 897812a50 Update template-debugging.md to include a jsonify example 22bca519b Update GitHub Pages hosting instructions (#2109) a964d93ce Document math functions new in v0.114.0 (#2108) 9f4cb040e netlify: Hugo 0.114.0 55b4d9221 Merge branch 'tempv0.114.0' 93c4dcf93 docs: Regen docshelper 96f03c77f docs: Regen CLI docs 8e22a228a Clarify resource media type variables (#2106) 2652da8d4 Update transform.Unmarshal.md (#2105) 92657177a Update theme 4601c1d65 Update theme a216f3145 Merge commit '3c1deaf201a35de08d23cc58f8f03682cace3349' eed8794f5 cache: Set default cache path based on $USER git-subtree-dir: docs git-subtree-split: c43daf45fdc36c254f4274a0815ea62d4d8c37e0
6.8 KiB
title | description | categories | keywords | menu | toc | weight | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Page resources | Page resources -- images, other pages, documents, etc. -- have page-relative URLs and their own metadata. |
|
|
|
true | 80 |
Page resources are only accessible from page bundles, those directories with index.md
or
_index.md
files at their root. Page resources are only available to the
page with which they are bundled.
In this example, first-post
is a page bundle with access to 10 page resources including audio, data, documents, images, and video. Although second-post
is also a page bundle, it has no page resources and is unable to directly access the page resources associated with first-post
.
content
└── post
├── first-post
│ ├── images
│ │ ├── a.jpg
│ │ ├── b.jpg
│ │ └── c.jpg
│ ├── index.md (root of page bundle)
│ ├── latest.html
│ ├── manual.json
│ ├── notice.md
│ ├── office.mp3
│ ├── pocket.mp4
│ ├── rating.pdf
│ └── safety.txt
└── second-post
└── index.md (root of page bundle)
Properties
- ResourceType
- The main type of the resource's Media Type. For example, a file of MIME type
image/jpeg
has the ResourceTypeimage
. APage
will haveResourceType
with valuepage
. - Name
- Default value is the file name (relative to the owning page). Can be set in front matter.
- Title
- Default value is the same as
.Name
. Can be set in front matter. - Permalink
- The absolute URL to the resource. Resources of type
page
will have no value. - RelPermalink
- The relative URL to the resource. Resources of type
page
will have no value. - Content
- The content of the resource itself. For most resources, this returns a string with the contents of the file. Use this to create inline resources.
{{ with .Resources.GetMatch "script.js" }}
<script>{{ .Content | safeJS }}</script>
{{ end }}
{{ with .Resources.GetMatch "style.css" }}
<style>{{ .Content | safeCSS }}</style>
{{ end }}
{{ with .Resources.GetMatch "img.png" }}
<img src="data:{{ .MediaType.Type }};base64,{{ .Content | base64Encode }}">
{{ end }}
- MediaType.Type
- The media type (formerly known as a MIME type) of the resource (e.g.,
image/jpeg
). - MediaType.MainType
- The main type of the resource's media type (e.g.,
image
). - MediaType.SubType
- The subtype of the resource's type (e.g.,
jpeg
). This may or may not correspond to the file suffix. - MediaType.Suffixes
- A slice of possible file suffixes for the resource's media type (e.g.,
[jpg jpeg jpe jif jfif]
).
Methods
- ByType
- Returns the page resources of the given type.
{{ .Resources.ByType "image" }}
- Match
- Returns all the page resources (as a slice) whose
Name
matches the given Glob pattern (examples). The matching is case-insensitive.
{{ .Resources.Match "images/*" }}
- GetMatch
- Same as
Match
but will return the first match.
Pattern matching
// Using Match/GetMatch to find this images/sunset.jpg ?
.Resources.Match "images/sun*" ✅
.Resources.Match "**/sunset.jpg" ✅
.Resources.Match "images/*.jpg" ✅
.Resources.Match "**.jpg" ✅
.Resources.Match "*" 🚫
.Resources.Match "sunset.jpg" 🚫
.Resources.Match "*sunset.jpg" 🚫
Page resources metadata
The page resources' metadata is managed from the corresponding page's front matter with an array/table parameter named resources
. You can batch assign values using wildcards.
{{% note %}}
Resources of type page
get Title
etc. from their own front matter.
{{% /note %}}
- name
- Sets the value returned in
Name
.
{{% note %}}
The methods Match
, Get
and GetMatch
use Name
to match the resources.
{{% /note %}}
- title
- Sets the value returned in
Title
- params
- A map of custom key/values.
Resources metadata example
{{< code-toggle copy=false >}} title: Application date : 2018-01-25 resources :
- src : "images/sunset.jpg" name : "header"
- src : "documents/photo_specs.pdf" title : "Photo Specifications" params: icon : "photo"
- src : "documents/guide.pdf" title : "Instruction Guide"
- src : "documents/checklist.pdf" title : "Document Checklist"
- src : "documents/payment.docx" title : "Proof of Payment"
- src : "**.pdf" name : "pdf-file-:counter" params : icon : "pdf"
- src : "**.docx" params : icon : "word" {{</ code-toggle >}}
From the example above:
sunset.jpg
will receive a newName
and can now be found with.GetMatch "header"
.documents/photo_specs.pdf
will get thephoto
icon.documents/checklist.pdf
,documents/guide.pdf
anddocuments/payment.docx
will getTitle
as set bytitle
.- Every
PDF
in the bundle exceptdocuments/photo_specs.pdf
will get thepdf
icon. - All
PDF
files will get a newName
. Thename
parameter contains a special placeholder:counter
, so theName
will bepdf-file-1
,pdf-file-2
,pdf-file-3
. - Every docx in the bundle will receive the
word
icon.
{{% note %}}
The order matters --- Only the first set values of the title
, name
and params
-keys will be used. Consecutive parameters will be set only for the ones not already set. In the above example, .Params.icon
is first set to "photo"
in src = "documents/photo_specs.pdf"
. So that would not get overridden to "pdf"
by the later set src = "**.pdf"
rule.
{{% /note %}}
The :counter
placeholder in name
and title
The :counter
is a special placeholder recognized in name
and title
parameters resources
.
The counter starts at 1 the first time they are used in either name
or title
.
For example, if a bundle has the resources photo_specs.pdf
, other_specs.pdf
, guide.pdf
and checklist.pdf
, and the front matter has specified the resources
as:
{{< code-toggle copy=false >}} resources src = "*specs.pdf" title = "Specification #:counter" resources src = "**.pdf" name = "pdf-file-:counter" {{</ code-toggle >}}
the Name
and Title
will be assigned to the resource files as follows:
Resource file | Name |
Title |
---|---|---|
checklist.pdf | "pdf-file-1.pdf |
"checklist.pdf" |
guide.pdf | "pdf-file-2.pdf |
"guide.pdf" |
other_specs.pdf | "pdf-file-3.pdf |
"Specification #1" |
photo_specs.pdf | "pdf-file-4.pdf |
"Specification #2" |