File Content
Shortcode to read content from page resources, site resources or project files, it's useful to reuse the content, such as the code snippets.
Donate
Become a backer or sponsor to support our work.
On this page
Sponsors
File Selection Order
- Page resources.
- Site resources.
- Project files.
Syntax
1{{< file-content "/path/to/file" >}}
Parameters
name
| Position | Name | Type | Required | Default | Since | Example |
|---|---|---|---|---|---|---|
#0 | name | string | ✓ | - | - | - |
The filename.
Examples
Reading From Page Resources
Source
1{{< file-content "data/foo.txt" >}}Result
barReading From Site Resources
assets/data/hello.js
1console.log('Hello world!')
Source
1{{< file-content "data/hello.js" >}}Result
Reading From Project Files
static/ads.txt
1google.com, pub-7827859788508375, DIRECT, f08c47fec0942fa0
Source
1{{< file-content "static/ads.txt" >}}Result
google.com, pub-7827859788508375, DIRECT, f08c47fec0942fa0Reading From Nonexistent File
Source
1{{< file-content "static/invalid.txt" >}}Result
Combine With Other Shortcodes
Take Bootstrap config toggle as an example.
content/docs/helpers/file-content/data/hugo.yaml
1title: Site Title
Source
1{{< bs/config-toggle hugo >}}
2{{< file-content "data/hugo.yaml" >}}
3{{< /bs/config-toggle >}}Result
hugo.yaml
1title: Site Title
hugo.toml
1title = 'Site Title'
hugo.json
1{
2 "title": "Site Title"
3}