mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
475f87f685
30f32a624 Update scss-sass.md 503130186 Update scss-sass.md cbfaa6704 Remove references to outdated Blackfriday markdown processor (#1748) e43948d26 netlify: Hugo 0.100.2 aaabe0ee9 Merge branch 'tempv0.100.2' bc615f257 tpl/path: Add path.BaseName function 5dddbf95e Add Chinese translation for _documentation and _index.md b1e4f3200 Add translation for search tools 23281633a Update introduction.md 3abb5fb5d netlify: Hugo 0.100.1 644ed3b01 Update faq.md 54f377051 Add some lines about resources.Copy 82cf08355 Remove most Blackfriday references bfbe5aaf3 netlify: Update to Hugo 0.100.0 8b6f8577f docs: Regen CLI docs 858a5d39c docs: Regen docs helper 5037d504f Merge commit 'e4bfe59c4e043c92d3992587d8c64d264b262a22' 03ca7be5b Fix indentation in highlight shortcode git-subtree-dir: docs git-subtree-split: 30f32a62433a6d62b680a2dd874c72bb8fb0b728
66 lines
2.9 KiB
Markdown
66 lines
2.9 KiB
Markdown
---
|
|
title: Local File Templates
|
|
linktitle: Local File Templates
|
|
description: Hugo's `readDir` and `readFile` functions make it easy to traverse your project's directory structure and write file contents to your templates.
|
|
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`][readDir] and [`readFile`][readFile] template functions, you can traverse your website's files on your server.
|
|
|
|
## Use `readDir`
|
|
|
|
The [`readDir` function][readDir] 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
|
|
|
|
## Use `readFile`
|
|
|
|
The [`readfile` function][readFile] 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 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 %}}
|
|
|
|
|
|
|
|
[called directly in the Hugo docs]: https://github.com/gohugoio/hugoDocs/blob/master/content/en/templates/files.md
|
|
[dirindex]: https://github.com/gohugoio/hugo/blob/master/docs/layouts/shortcodes/directoryindex.html
|
|
[osfileinfo]: https://golang.org/pkg/os/#FileInfo
|
|
[readDir]: /functions/readdir/
|
|
[readFile]: /functions/readfile/
|
|
[sc]: /content-management/shortcodes/
|
|
[sct]: /templates/shortcode-templates/
|
|
[readfilesource]: https://github.com/gohugoio/hugoDocs/blob/master/layouts/shortcodes/readfile.html
|
|
[testfile]: https://github.com/gohugoio/hugoDocs/blob/master/content/en/readfiles/testing.txt
|