Index: A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
YAML is a recursive acronym for "YAML Ain't Markup Language". YAML is a data serialization language that takes concepts from languages such as XML, C, Python, and Perl, as well as the format for electronic mail as specified by RFC 2822. YAML was first proposed by Clark Evans , and implemented by himself, Brian Ingerson and Oren Ben-Kiki .1 Features
YAML was created with the belief that all data can be adequately represented by combinations of lists, hashes, and scalar data. The syntax is relatively straightforward and was designed with human readability in mind, but also to be easily mapped to data types common to most high-level languages:
- Comments are denoted by the pound sign (#) and continue until the end of the line
- List members are denoted by a leading hyphen (-) with one member per line, or as comma-separated values enclosed in brackets ([ & ])
- Hashes are represented in the form key: value, either one per line or enclosed in parentheses (( & )) and delimited by commas
- Scalars may be double-quoted ("), single-quoted ('), or represented by an indented block with optional modifiers to preserve (|) or fold (>) newlines
- Multiple documents within a single stream are separated by three hyphens (---); three periods (...) optionally end a document within a stream
- Repeated nodes are initially denoted by an ampersand (&) and thereafter referenced with an asterisk (*)
2 Examples
2.1 Lists
--- # Favorite movies, block format
- Casablanca
- Spellbound
- Notorious
--- # Shopping list, inline format
[milk, bread, eggs]
2.2 Hashes
--- # Block
name: John Smith
age: 33
--- # Inline
(name: John Smith, age: 33)
2.3 Block Literals
2.3.1 Newlines preserved
--- |
There was a young fellow of Warwick
Who had reason for feeling euphoric
For he could, by election
Have triune erection
Ionic, Corinthian, and Doric
2.3.2 Newlines folded
--- >
Wrapped text
will be folded
into a single
paragraph
Blank lines denote
paragraph breaks
2.4 Lists of Hashes
- (name: John Smith, age: 33)
-
name: Mary Smith
age: 27
2.5 Hashes of Lists
men: [John Smith, Bill Jones]
women:
- Mary Smith
- Susan Williams
3 Implementations
Bindings for YAML exist for the following languages:
4 External links
Markup languages
Read more »