summaryrefslogtreecommitdiff
path: root/yaml_cheat_sheet.md
diff options
context:
space:
mode:
Diffstat (limited to 'yaml_cheat_sheet.md')
-rw-r--r--yaml_cheat_sheet.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/yaml_cheat_sheet.md b/yaml_cheat_sheet.md
new file mode 100644
index 0000000..b00e78b
--- /dev/null
+++ b/yaml_cheat_sheet.md
@@ -0,0 +1,30 @@
+# YAML Cheat Sheet
+
+### YAML example
+
+```yaml
+# Comments in YAML look like this
+
+key: value
+another_key: Another value goes here.
+a_number_value: 100
+
+# Nesting uses indentation. 2 space indent is preferred (but not required).
+a_nested_map:
+ key: value
+ another_key: Another Value
+ another_nested_map:
+ hello: hello
+
+# Sequences (equivalent to lists or arrays) look like this
+# (note that the '-' counts as indentation):
+a_sequence:
+ - Item 1
+ - Item 2
+
+# Since YAML is a superset of JSON, you can also write JSON-style maps and sequences:
+json_map: {"key": "value"}
+json_seq: [3, 2, 1, "takeoff"]
+```
+
+Checking YAML files' formatting can be done using `yamllint`