mirror of
https://github.com/opentffoundation/opentf.git
synced 2026-03-06 15:01:13 -05:00
48d940323e
Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
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.
|