hugo/docs/content/en/functions/readfile.md
2023-05-22 16:47:07 +02:00

35 lines
953 B
Markdown

---
title: readFile
description: Returns the contents of a file.
categories: [functions]
menu:
docs:
parent: functions
keywords: [files]
signature: ["os.ReadFile PATH", "readFile PATH"]
relatedfuncs: ['os.FileExists','os.ReadDir','os.Stat']
---
The `os.ReadFile` function attempts to resolve the path relative to the root of your project directory. If a matching file is not found, it will attempt to resolve the path relative to the [`contentDir`](/getting-started/configuration#contentdir). A leading path separator (`/`) is optional.
With a file named README.md in the root of your project directory:
```text
This is **bold** text.
```
This template code:
```go-html-template
{{ os.ReadFile "README.md" }}
```
Produces:
```html
This is **bold** text.
```
Note that `os.ReadFile` returns raw (uninterpreted) content.
For more information on using `readDir` and `readFile` in your templates, see [Local File Templates](/templates/files).