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:

subs:
  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.

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

Substitutions should work in code blocks too.

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/

Here is a variable with dashes: A key with dashes