﻿---
title: Substitutions
description: Substitutions can be defined in two places: In the frontmatter YAML within a file.Globally for all files in docset.yml. In both cases the yaml to define...
url: https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/2626/syntax/substitutions
---

# Substitutions
Substitutions can be defined in two places:
1. In the `frontmatter` YAML within a file.
2. Globally for all files in `docset.yml`

In both cases the yaml to define them is as followed:
```yaml
sub:
  key: value
  another-var: Another Value
```

If a substitution is defined globally it may not be redefined (shaded) in a files `frontmatter`.
Doing so will result in a build error.
To use the variables in your files, surround them in curly brackets (`{{variable}}`). Substitutions work in:
- Regular text content
- Code blocks (when `subs=true` is specified)
- Inline code snippets (when `{subs}` prefix is used)


## Example

Here are some variable substitutions:

| Variable                       | Defined in     |
|--------------------------------|----------------|
| Front Matter Value             | Front Matter   |
| A key with dashes              | Front Matter   |
| This was defined in docset.yml | `docset.yml`   |
| Kibana                         | `products.yml` |
| Kibana                         | `products.yml` |


## Mutations

Substitutions can be mutated using a chain of operators seperated by a pipe (`|`).
```markdown
`{{hello-world | trim | lc | tc}}`
```

Will trim, lowercase and finally titlecase the contents of the 'hello-world' variable.

### Operators


| Operator | Purpose                                            |
|----------|----------------------------------------------------|
| `lc`     | LowerCase,                                         |
| `uc`     | UpperCase,                                         |
| `tc`     | TitleCase, capitalizes all words,                  |
| `c`      | Capitalize the first letter,                       |
| `kc`     | Convert to KebabCase,                              |
| `sc`     | Convert to SnakeCase,                              |
| `cc`     | Convert to CamelCase,                              |
| `pc`     | Convert to PascalCase,                             |
| `trim`   | Trim common non word characters from start and end |

For variables declaring a semantic version or `Major.Minor` the following operations are also exposed

| Operator | Purpose                                  |
|----------|------------------------------------------|
| `M`      | Display only the major component         |
| `M.x`    | Display major component followed by '.x' |
| `M.M`    | Display only the major and the minor     |
| `M+1`    | The next major version                   |
| `M.M+1`  | The next minor version                   |


### Example

Given the following frontmatter:
```yaml
---
sub:
  hello-world: "Hello world!"
---
```

<tab-set>
  <tab-item title="Output">
    - Lowercase: Hello world!
    - Uppercase: Hello world!
    - TitleCase: Hello world!
    - kebab-case: Hello world!
    - camelCase: Hello world!
    - PascalCase: Hello world!
    - SnakeCase: Hello world!
    - CapitalCase (chained): Hello world!
    - Trim: Hello world!
    - M.x: 9.3.0
    - M.M: 9.3.0
    - M: 9.3.0
    - M+1: 9.3.0
    - M+1  M.M: 9.3.0
    - M.M+1: 9.3.0
  </tab-item>

  <tab-item title="Markdown">
    ```markdown
    * Lowercase: {{hello-world | lc}}
    * Uppercase: {{hello-world | uc}}
    * TitleCase: {{hello-world | tc}}
    * kebab-case: {{hello-world | kc}}
    * camelCase: {{hello-world | tc | cc}}
    * PascalCase: {{hello-world | pc}}
    * SnakeCase: {{hello-world | sc}}
    * CapitalCase (chained): {{hello-world | lc | c}}
    * Trim: {{hello-world | trim}}
    * M.x: {{version.stack | M.x }}
    * M.M: {{version.stack | M.M }}
    * M: {{version.stack | M }}
    * M+1: {{version.stack | M+1 }}
    * M+1 | M.M: {{version.stack | M+1 | M.M }}
    * M.M+1: {{version.stack | M.M+1 }}
    ```
  </tab-item>
</tab-set>


## Code blocks

Substitutions are supported in code blocks but are disabled by default. Enable substitutions by adding `subs=true` to the code block.
```markdown
```bash subs=true
# Your code with variables
```
```


### Code directive with subs enabled

<tab-set>
  <tab-item title="Output">
    ```sh
    wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-7.17.0-linux-x86_64.tar.gz
    wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-7.17.0-linux-x86_64.tar.gz.sha512
    shasum -a 512 -c elasticsearch-7.17.0-linux-x86_64.tar.gz.sha512
    tar -xzf elasticsearch-7.17.0-linux-x86_64.tar.gz
    cd elasticsearch-7.17.0/
    ```
  </tab-item>

  <tab-item title="Markdown">
    ```markdown
    ```{code} sh subs=true
    wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version}}-linux-x86_64.tar.gz
    wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version}}-linux-x86_64.tar.gz.sha512
    shasum -a 512 -c elasticsearch-{{version}}-linux-x86_64.tar.gz.sha512
    tar -xzf elasticsearch-{{version}}-linux-x86_64.tar.gz
    cd elasticsearch-{{version}}/
    ```
    ```
  </tab-item>
</tab-set>


## Inline code

Substitutions are also supported in inline code snippets using the `{subs}` syntax.
```markdown
{subs}`wget elasticsearch-{{version.stack}}.tar.gz`
```


### Inline code examples

<tab-set>
  <tab-item title="Output">
    Regular inline code: `wget elasticsearch-{{version.stack}}.tar.gz`With substitutions: `wget elasticsearch-{{version.stack}}.tar.gz`Multiple variables: `export {{env-var}}={{version.stack}}`With mutations: `version {{version.stack | M.M}}`
  </tab-item>

  <tab-item title="Markdown">
    ```markdown
    Regular inline code: `wget elasticsearch-{{version.stack}}.tar.gz`

    With substitutions: {subs=true}`wget elasticsearch-{{version.stack}}.tar.gz`

    Multiple variables: {subs=true}`export {{env-var}}={{version.stack}}`

    With mutations: {subs=true}`version {{version.stack | M.M}}`
    ```
  </tab-item>
</tab-set>

<note>
  Regular inline code (without the `{subs}` role) will not process substitutions and will display the variable placeholders as-is.
</note>


## Products

Product substitutions use [`products.yml`](https://github.com/elastic/docs-builder/blob/main/config/products.yml) to determine what will be displayed. Use the product's key to get its display name.
```yaml
# products.yml

id:
  display: {value}
  ...
# example:
  apm-agent-dotnet:
    display: 'APM .NET Agent'
```

A shorthand format is also available. Using `{{.id}}` is equivalent to `{{product.id}}`.