34 lines
778 B
Markdown
34 lines
778 B
Markdown
|
---
|
||
|
|
layout: "functions"
|
||
|
|
page_title: "indent function"
|
||
|
|
sidebar_current: "docs-funcs-string-indent"
|
||
|
|
description: |-
|
||
|
|
The indent function adds a number of spaces to the beginnings of all but the
|
||
|
|
first line of a given multi-line string.
|
||
|
|
---
|
||
|
|
|
||
|
|
# `indent` Function
|
||
|
|
|
||
|
|
`indent` adds a given number of spaces to the beginnings of all but the first
|
||
|
|
line in a given multi-line string.
|
||
|
|
|
||
|
|
```hcl
|
||
|
|
indent(num_spaces, string)
|
||
|
|
```
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
This function is useful for inserting a multi-line string into an
|
||
|
|
already-indented context in another string:
|
||
|
|
|
||
|
|
```
|
||
|
|
> " items: %{indent(2, "[\n foo,\n bar,\n]\n")}"
|
||
|
|
items: [
|
||
|
|
foo,
|
||
|
|
bar,
|
||
|
|
]
|
||
|
|
```
|
||
|
|
|
||
|
|
The first line of the string is not indented so that, as above, it can be
|
||
|
|
placed after an introduction sequence that has already begun the line.
|