2017-08-10 11:18:22 -04:00
---
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"
2017-09-21 13:03:00 -04:00
keywords: [files]
2017-08-10 11:18:22 -04:00
signature: ["readFile PATH"]
workson: []
hugoversion:
relatedfuncs: [readDir]
deprecated: false
aliases: []
---
2018-04-21 17:01:55 -04:00
Note that the filename must be relative to the current project working directory, or the project's `/content` folder.
2017-08-10 11:18:22 -04:00
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!"
```
2018-04-21 17:01:55 -04:00
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.
2019-07-15 17:49:41 -04:00
Note that there is a 1 MB file size limit.
2017-08-10 11:18:22 -04:00
For more information on using `readDir` and `readFile` in your templates, see [Local File Templates][local].
[local]: /templates/files/