summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/os/ReadFile.md
blob: 7f25327c8e853733157f7f652558b6410d4e7918 (plain) (blame)
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
---
title: os.ReadFile
description: Returns the contents of a file.
categories: []
keywords: []
params:
  functions_and_methods:
    aliases: [readFile]
    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`](/configuration/all/#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.