blob: 654e300ac88a6ffa762b6bbdeff320f15520fd98 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
---
title: os.ReadFile
description: Returns the contents of a file.
categories: []
keywords: []
action:
aliases: [readFile]
related:
- functions/os/FileExists
- functions/os/Getenv
- functions/os/ReadDir
- functions/os/Stat
returnType: string
signatures: [os.ReadFile PATH]
aliases: [/functions/readfile]
---
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
{{ 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).
|
