mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
9d31f650da
bb15e9804 Update index.md (#1339) ffb2f21d1 Update index.md fc154ac02 Regenerate CLI docs a0a687738 Update index.md d0e35a844 Update index.md 86d0cc042 Update index.md bdaf7e022 Release 0.81.0 b51017445 releaser: Add release notes to /docs for release of 0.81.0 888dd8fcc docs: Regen CLI docs 8c3e8b270 docs: Regen docs helper 79e3e1ebc Merge commit 'acb9109df778fa4a51c0d8b29b3212b12988908f' 31f70af7e modules: Add config option modules.vendorClosest 2631df94e markup/goldmark: Add attributes support for blocks (tables etc.) 19dee04ad Update to Dart Sass Protocol beta6 e507721fe Refactor: Write to stdout by default d204bf160 Refactor: Remove powershell support 91bea48f5 Feat: Add zsh, fish and powershell completion support 9c915ea27 docs: Remove mention of a file size limit for readFile 5acc8b6c7 js: Add Inject config option 45321989e js: Add Shims option git-subtree-dir: docs git-subtree-split: bb15e9804ae56da41f3bdb361adc14f8711fc19d
33 lines
1 KiB
Markdown
33 lines
1 KiB
Markdown
---
|
|
title: readFile
|
|
description: Reads a file from disk relative to the current project working directory and returns a string.
|
|
godocref:
|
|
date: 2017-02-01
|
|
publishdate: 2017-02-01
|
|
lastmod: 2017-04-30
|
|
categories: [functions]
|
|
menu:
|
|
docs:
|
|
parent: "functions"
|
|
keywords: [files]
|
|
signature: ["readFile PATH"]
|
|
workson: []
|
|
hugoversion:
|
|
relatedfuncs: [readDir]
|
|
deprecated: false
|
|
aliases: []
|
|
---
|
|
|
|
Note that the filename must be relative to the current project working directory, or the project's `/content` folder.
|
|
|
|
So, if you have a file with the name `README.txt` in the root of your project with the content `Hugo Rocks!`:
|
|
|
|
```
|
|
{{readFile "README.txt"}} → "Hugo Rocks!"
|
|
```
|
|
|
|
If you receive a "file doesn't exist" error with a path listed, do take note that the path is the last one checked by the function, and may not accurately reflect your target. You should generally double-check your path for mistakes.
|
|
|
|
For more information on using `readDir` and `readFile` in your templates, see [Local File Templates][local].
|
|
|
|
[local]: /templates/files/
|