File Content Shortcode

September 3, 2023 1 min read Docs

Reading content from page resources, site resources or static files, it's useful to reuse the content, such as the code snippets, notes and so on.

Donate

Become a backer or sponsor to support our work.

On this page

File Selection Order

Page resource.
Site resource.
Project files.

Syntax

1{{< file-content "/path/to/file" >}}

Parameters

`name`

Position	Name	Type	Default	Required
`#0`	`name`	`string`	-	Y

The filename.

Examples

Reading From Page Resource

content/docs/shortcodes/file-content/data/foo.txt

  <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-text" data-lang="text"><span class="line"><span class="ln">1</span><span class="cl">bar

1{{< file-content "data/foo.txt" >}}

bar

Reading From Site Resource

assets/data/hello.js

  <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-js" data-lang="js"><span class="line"><span class="ln">1</span><span class="cl"><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">&#39;Hello world!&#39;</span><span class="p">)</span>

1```js
2{{< file-content "data/hello.js" >}}
3```

1console.log('Hello world!')

Reading From Projects File

static/ads.txt

  <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-text" data-lang="text"><span class="line"><span class="ln">1</span><span class="cl">google.com, pub-7827859788508375, DIRECT, f08c47fec0942fa0

1{{< file-content "static/ads.txt" >}}

google.com, pub-7827859788508375, DIRECT, f08c47fec0942fa0

Reading From Nonexistent File

1{{< file-content "static/invalid.txt" >}}

Combine With Other Shortcodes

Take Bootstrap config toggle as an example.

content/docs/shortcodes/file-content/data/hugo.yaml

  <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="ln">1</span><span class="cl"><span class="nt">title</span><span class="p">:</span><span class="w"> </span><span class="l">Site Title</span><span class="w">

1{{< bs/config-toggle hugo >}}
2{{< file-content "data/hugo.yaml" >}}
3{{< /bs/config-toggle >}}

hugo.yaml

1title: Site Title

hugo.toml

1title = 'Site Title'

hugo.json

1{
2   "title": "Site Title"
3}

Browse Docs