silverbullet/website/YAML.md

26 lines
770 B
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

YAML stands for “YAML Aint Markup Language.” More information can be found at [the YAML website](https://yaml.org/).
SilverBullet uses YAML in various contexts, specifically [[Frontmatter]] and [[Space Config]]
# Internal links
Many string values can be written directly in YAML without any quoting, like:
```yaml
property: value
```
However when you want to reference [[Links|a page]] or [[Command links|command]] you will need to quote the full link:
```yaml
some page: "[[Pages]]"
list of pages:
- "[[Pages]]"
- "[[Links]]"
```
This is because the square brackets used in the internal link format have a meaning in YAML as well. So an unquoted link is parsed as list inside a list:
```yaml
some page: [[Pages]]
equivalent yaml: [
[ "Pages" ]
]
```