mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
ba45da9d03
32356e4e Fix typo in header of shortcode-templates.md c8f1a2d2 Correct code example for index template function bfa6a55d Escape code fencing ff8b2f99 Fix typos in deployment with wercker tutorial 557c36e8 theme: Merge commit '7fbb4bed25001182bfeb91f79db0f0c1936582ee' 7fbb4bed Squashed 'themes/gohugoioTheme/' changes from 7dd8a302..ca53082d ce31cee0 Add "See Also" config 158cee1b Make the tags into keywords 61600be6 Add a note to the related section 49edb5a2 Relase 0.27.1 c9bbc001 releaser: Add release notes to /docs for release of 0.27.1 213c6c3b Add bugs poster 8b4590cd Add KeyCDN integration tutorial 2b277859 Add tutorial videos to several docs pages 950fef1f Update roadmap to link to the correct milestones page 496f5bf6 Rename relnotes d6f9378d Bump Netlify versions to 0.27 087fde7f Update 0.27 release notes 603f94ae docs: Document Related Content 3790f6a3 releaser: Bump versions for release of 0.27 0948868c releaser: Add release notes to /docs for release of 0.27 git-subtree-dir: docs git-subtree-split: 32356e4eabe357ae914f4d1d59e8ae31ce936723
114 lines
4.7 KiB
Markdown
114 lines
4.7 KiB
Markdown
---
|
|
title: Local File Templates
|
|
linktitle: Local File Templates
|
|
description: Hugo's `readerDir` and `readFile` functions make it easy to traverse your project's directory structure and write file contents to your templates.
|
|
godocref: https://golang.org/pkg/os/#FileInfo
|
|
date: 2017-02-01
|
|
publishdate: 2017-02-01
|
|
lastmod: 2017-02-01
|
|
categories: [templates]
|
|
keywords: [files,directories]
|
|
menu:
|
|
docs:
|
|
parent: "templates"
|
|
weight: 110
|
|
weight: 110
|
|
sections_weight: 110
|
|
draft: false
|
|
aliases: [/extras/localfiles/,/templates/local-files/]
|
|
toc: true
|
|
---
|
|
|
|
## Traverse Local Files
|
|
|
|
With Hugo's [`readDir` and `readFile` template functions][reads], you can traverse your website's files on your server.
|
|
|
|
## Use `readDir`
|
|
|
|
The [`readDir` function][reads] returns an array of [`os.FileInfo`][osfileinfo]. It takes the file's `path` as a single string argument. This path can be to any directory of your website (i.e., as found on your server's file system).
|
|
|
|
Whether the path is absolute or relative does not matter because---at least for `readDir`---the root of your website (typically `./public/`) in effect becomes both:
|
|
|
|
1. The file system root
|
|
2. The current working directory
|
|
|
|
### `readDir` Example: List Directory Files
|
|
|
|
This shortcode creates a link to each of the files in a directory---display as the file's basename---along with the file's size in bytes.
|
|
|
|
{{< code file="layouts/shortcodes/directoryindex.html" download="directoryindex.html" >}}
|
|
{{< readfile file="/themes/gohugoioTheme/layouts/shortcodes/directoryindex.html" >}}
|
|
{{< /code >}}
|
|
|
|
You can then call the shortcode as follows inside of your content's markup:
|
|
|
|
```
|
|
{{</* directoryindex path="/static/css" pathURL="/css" */>}}
|
|
```
|
|
|
|
The above shortcode [is part of the code for the Hugo docs][dirindex]. Here it lists this site's CSS files:
|
|
|
|
{{< directoryindex path="/themes/gohugoioTheme/static/dist" pathURL="/css" >}}
|
|
|
|
{{% note "Slashes are Important" %}}
|
|
The initial slash `/` in `pathURL` is important in the `directoryindex` shortcode. Otherwise, `pathURL` becomes relative to the current web page.
|
|
{{% /note %}}
|
|
|
|
## Use `readFile`
|
|
|
|
The [`readfile` function][reads] reads a file from disk and converts it into a string to be manipulated by other Hugo functions or added as-is. `readFile` takes the file, including path, as an argument passed to the function.
|
|
|
|
To use the `readFile` function in your templates, make sure the path is relative to your *Hugo project's root directory*:
|
|
|
|
```
|
|
{{ readFile "/content/templates/local-file-templates" }}
|
|
```
|
|
|
|
### `readFile` Example: Add a Project File to Content
|
|
|
|
As `readFile` is a function, it is only available to you in your templates and not your content. However, we can create a simple [shortcode template][sct] that calls `readFile`, passes the first argument through the function, and then allows an optional second argument to send the file through the Blackfriday markdown processor. The pattern for adding this shortcode to your content will be as follows:
|
|
|
|
```
|
|
{{</* readfile file="/path/to/local/file.txt" markdown="true" */>}}
|
|
```
|
|
|
|
{{% warning %}}
|
|
If you are going to create [custom shortcodes](/templates/shortcode-templates/) with `readFile` for a theme, note that usage of the shortcode will refer to the project root and *not* your `themes` directory.
|
|
{{% /warning %}}
|
|
|
|
Here is the templating for our new `readfile` shortcode:
|
|
|
|
{{< code file="layouts/shortcodes/readfile.html" download="readfile.html" >}}
|
|
{{< readfile file="/themes/gohugoioTheme/layouts/shortcodes/readfile.html">}}
|
|
{{< /code >}}
|
|
|
|
This `readfile` shortcode is [also part of the Hugo docs][readfilesource]. So is [`testing.txt`][testfile], which we will call in this example by passing it into our new `readfile` shortcode as follows:
|
|
|
|
```
|
|
{{</* readfile file="/content/readfiles/testing.txt" */>}}
|
|
```
|
|
|
|
The output "string" for this shortcode declaration will be the following:
|
|
|
|
```
|
|
{{< readfile file="/content/readfiles/testing.txt" >}}
|
|
```
|
|
|
|
However, if we want Hugo to pass this string through Blackfriday, we should add the `markdown="true"` optional parameter:
|
|
|
|
```
|
|
{{</* readfile file="/content/readfiles/testing.txt" markdown="true" */>}}
|
|
```
|
|
|
|
And here is the result as [called directly in the Hugo docs][] and rendered for display:
|
|
|
|
{{< readfile file="/content/readfiles/testing.txt" markdown="true">}}
|
|
|
|
[called directly in the Hugo docs]: https://github.com/gohugoio/hugo/blob/master/docs/content/templates/files.md
|
|
[dirindex]: https://github.com/gohugoio/hugo/blob/master/docs/layouts/shortcodes/directoryindex.html
|
|
[osfileinfo]: https://golang.org/pkg/os/#FileInfo
|
|
[reads]: /functions/readfile/
|
|
[sc]: /content-management/shortcodes/
|
|
[sct]: /templates/shortcode-templates/
|
|
[readfilesource]: https://github.com/gohugoio/hugo/blob/master/
|
|
[testfile]: https://github.com/gohugoio/hugo/blob/master/docs/testfile
|