mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
41 lines
1 KiB
Markdown
41 lines
1 KiB
Markdown
|
---
|
||
|
|
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).
|