Difference between revisions of "Yaml"
(add thumb) |
|||
| (4 intermediate revisions by the same user not shown) | |||
| Line 3: | Line 3: | ||
See [[wp:YAML]] | See [[wp:YAML]] | ||
| − | I learned it when it was first introduced in 2001 so at that time it was known as "Yet Another Markup Language", however the acronym later became a recursive backcronym standing for "YAML Ain't Markup Language". | + | I learned it when it was first introduced in 2001 so at that time it was known as "Yet Another Markup Language", however the acronym later became a recursive backcronym standing for "'''YAML Ain't Markup Language'''". So, what is it then? Well, it's a data serialization format. It is a superset of JSON, which means that any valid JSON is valid YAML. |
| − | + | YAML is used everywhere, such as the '''[[Ansible]]''' project. If you want to use Ansible, learning YAML first will help you tremendously. If you're ready to jump in, see [https://docs.ansible.com/ansible/latest/playbook_guide/playbooks.html#working-with-playbooks Working with Playbooks] in the Ansible docs. | |
| + | |||
| + | ==Resources== | ||
| + | [https://www.redhat.com/sysadmin/yaml-tips 10 Tips by RedHat] | ||
| + | |||
| + | [https://betterprogramming.pub/10-things-you-might-not-know-about-yaml-b0589da547c 10 Things you might not know about YAML] | ||
| + | |||
| + | {{#ev:youtube|UlkIZG3yiCM}} | ||
| + | |||
| + | https://www.xkyle.com/A-Detailed-Comparison-of-YAML-Formatters/ | ||
| + | |||
| + | ===Tools=== | ||
| + | '''<code>yamllint</code>''' https://github.com/adrienverge/yamllint GPL3 | ||
| + | |||
| + | For more on '''Syntax''' rules and examples; plus linting your YAML, see [[yamllint]] | ||
| + | |||
| + | ==Snippets== | ||
| + | <syntaxhighlight lang="yaml+jinja"> | ||
| + | # This file IS valid YAML because the Jinja is in a YAML comment | ||
| + | # {% if extra_info %} | ||
| + | key1: value1 | ||
| + | # {% endif %} | ||
| + | key2: value2 | ||
| + | </syntaxhighlight> | ||
[[Category:Markup]] | [[Category:Markup]] | ||
Latest revision as of 10:45, 1 November 2024
See wp:YAML
I learned it when it was first introduced in 2001 so at that time it was known as "Yet Another Markup Language", however the acronym later became a recursive backcronym standing for "YAML Ain't Markup Language". So, what is it then? Well, it's a data serialization format. It is a superset of JSON, which means that any valid JSON is valid YAML.
YAML is used everywhere, such as the Ansible project. If you want to use Ansible, learning YAML first will help you tremendously. If you're ready to jump in, see Working with Playbooks in the Ansible docs.
Resources[edit | edit source]
10 Things you might not know about YAML
https://www.xkyle.com/A-Detailed-Comparison-of-YAML-Formatters/
Tools[edit | edit source]
yamllint https://github.com/adrienverge/yamllint GPL3
For more on Syntax rules and examples; plus linting your YAML, see yamllint
Snippets[edit | edit source]
# This file IS valid YAML because the Jinja is in a YAML comment
# {% if extra_info %}
key1: value1
# {% endif %}
key2: value2
