Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/json-next/awesome-yaml
A Collection of Awesome YAML (Ain't Markup Language) Goodies for Structured (Meta) Data in Text
https://github.com/json-next/awesome-yaml
List: awesome-yaml
data json metadata opendata txt yaml
Last synced: about 1 month ago
JSON representation
A Collection of Awesome YAML (Ain't Markup Language) Goodies for Structured (Meta) Data in Text
- Host: GitHub
- URL: https://github.com/json-next/awesome-yaml
- Owner: json-next
- License: cc0-1.0
- Created: 2017-06-28T16:43:20.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-16T22:40:21.000Z (over 1 year ago)
- Last Synced: 2024-05-23T10:05:17.133Z (7 months ago)
- Topics: data, json, metadata, opendata, txt, yaml
- Homepage:
- Size: 14.6 KB
- Stars: 31
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- fucking-lists - awesome-yaml
README
``` yaml
The design goals for YAML:
- YAML is easily readable by humans.
- YAML data is portable between programming languages.
- YAML matches the native data structures of agile languages.
- YAML has a consistent model to support generic tools.
- YAML supports one-pass processing.
- YAML is expressive and extensible.
- YAML is easy to implement and use.
```
# Awesome YAML (Ain't Markup Language)
A collection of Awesome YAML (Ain't Markup Language) goodies for structured (meta) data in text.
#### _Contributions welcome. Anything missing? Send in a pull request. Thanks._
## Formats
### "Standard" YAML
**YAML HQ**
- [`yaml.org`](http://www.yaml.org) - official YAML website by Clark C. Evans
- [YAML Spec v1.2](http://yaml.org/spec/1.2/spec.html) - 3rd edition, Oct 2009
- [YAML Quick Reference Card](http://www.yaml.org/refcard.html) - one-page cheat sheet
### "Safe" YAML, "Strict" YAML
- [`strictyaml`](https://github.com/crdoconnor/strictyaml) - a type-safe YAML parser that parses and validates a restricted subset of the YAML specification
- [YAML Features Removed](https://hitchdev.com/strictyaml/features-removed/)
- NO Implicit Typing
- NO Direct representations of objects
- NO Duplicate Keys Disallowed
- NO Explicit tags
- NO Node anchors and refs
- NO Flow style
### Nested Text - YAML Simplified, YAML Evolved
_"Safer" YAML - YAML Redux_
- [`nestedtext.org`](https://nestedtext.org), [(github)](https://github.com/KenKundert/nestedtext) - a human friendly data format similar to YAML but without the complexity and risk of YAML
Example:
```
# Contact information for our officers
president:
name: Katheryn McDaniel
address:
> 138 Almond Street
> Topeka, Kansas 20697
phone:
cell: 1-210-555-5297
home: 1-210-555-8470
# Katheryn prefers that we always call her on her cell phone.
email: [email protected]
additional roles:
- board member
```
## Articles
- [**YAML Quick Reference (Cheat Sheet) for Jekyll Data Files, Front Matter and Collections**](https://github.com/planetjekyll/quickrefs/blob/master/YAML.md), Planet Jekyll
- [**Learn YAML in Y Minutes**](https://learnxinyminutes.com/docs/yaml), Learn X in Y minutes series,
- [**Deep dive into TOML, JSON and YAML**](https://gohugohq.com/howto/toml-json-yaml-comparison/), Go Hugo HQ, Dec 2016
- [**YAML @ Wikipedia**](https://en.wikipedia.org/wiki/YAML)
## Tips & Gotchas
**Strings with Colons (`:`)**
When to use quotes for your strings?
If your string includes a colon (`:`) followed by a space you MUST quote your string. Otherwise, the colon is interpreted as a key/value separator (e.g. _key: value_). Example:
``` yaml
title: "Text Processing with Ruby: Extract Value from the Data That Surrounds You"
title: "Sinatra: Up and Running - Ruby for the Web, Simply"
title: "Using JRuby: Bringing Ruby to Java"
```
Note: You can quote your strings using double quotes (`""`) e.g. "Using JRuby: Bringing Ruby to Java"
or single quotes(`''`) e.g. 'Using JRuby: Bringing Ruby to Java'.
**No Tabs (\t) for Indentation - Use Spaces, Period**
Note: Always use spaces for indentation, period.
Make sure no tabs (`\t`) have somehow ended up in your datafile leading to
unexpected results.
**Predefined Boolean 'n' No Value Constants - True/False, Yes/No, On/Off, ~/Null**
Note: The boolean `true` and `false` constants e.g.:
```
true, True, TRUE
y, Y, yes, YES, YES
on, ON, ON
false, False, FALSE
n, N, no, No, NO
off, Off, OFF
```
will become boolean values e.g. `true` or `false`. If you want end-up with a string e.g.:
``` yaml
recommend: Yes # note: will become => true (boolean)
```
make sure you use a quoted version e.g.:
``` yaml
recommend: "Yes" # note: will become => "Yes" (string)
```
Note: The same holds for the no value null constants e.g.:
``` yaml
~
null, Null, NULL
```
will become => `null` (no value). Note: A key without a value will end-up with a `null` value (and not an empty string, for example). To get an empty string use `""` e.g.:
``` yaml
key1: # note: value will become => null (no value); same as key1: null or key1: ~
key2: "" # note: value will become => "" (string)
```
## JSON
_JSON is (a subset of) YAML, that is YAML is JSON but JSON is NOT YAML ;-)_
Example: Use the inline style for lists (that is, JSON arrays)
and hashes (that is, JSON objects) for an alternative "JSON-style" syntax:
``` json
[
{ "title": "football.db - Open Football Data",
"url": "https://github.com/openfootball"
},
{ "title": "beer.db - Open Beer, Brewery 'n' Brewpub Data",
"url": "https://github.com/openbeer"
}
]
```
is the same as:
``` yaml
- title : football.db - Open Football Data
url : https://github.com/openfootball
- title : beer.db - Open Beer, Brewery 'n' Brewpub Data
url : https://github.com/openbeer
```
## Tools & Services
- [**YAML Linter @ yamllint.com**](http://www.yamllint.com) - online YAML validator / checker
- [**YAML Validator @ Code Beautify**](https://codebeautify.org/yaml-validator) - online YAML validator / checker
- [**YAML Comparator @ yamline**](https://yamline.com/compare/) - online YAML comparator
- [**Yamlinc**](https://github.com/javanile/yamlinc) - compose multiple files using $include tag / compiler
- [**dasel ("data-selector")**](https://github.com/tomwright/dasel) - Query and update data structures using selectors from the command line. Comparable to [jq](https://github.com/stedlan/jq) / [yq](https://github.com/kislyuk/yq) but supports JSON, YAML, TOML and XML with zero runtime dependencies.
## No Body Wants To Write YAML
``` yaml
No:
Body:
Wants:
To:
Write:
- YAML
```
- [**`noyaml.com`**](https://noyaml.com), [(github)](https://github.com/ghuntley/noyaml) - a rant about the state of devops tooling / the infrastructure sector
Mandatory "No Body Wants To Write YAML" reading list:
- [Today we’re going to look at some general problems with the YAML format](https://arp242.net/yaml-config.html)
- [We replaced 1,000 lines of YAML with 10 structs and people started contributing again](https://tinyurl.com/lessons-in-over-engineering)
- [What if you used the same language and tools you use to define your app to define your infrastructure?](https://twitter.com/ellism/status/1008728148131733504)
- [A YAML file is almost always still 'valid' even if it is trunca](https://twitter.com/colmmacc/status/1057316977457324032)
- [The bug was that the YAML parser ignored the negative signs ... so negative GPS coordinates became positive ones](https://twitter.com/colmmacc/status/1063470541464461312)
- [Every YAML parser is a custom YAML parser](https://matrix.yaml.io/valid.html)
- [There are 63 different ways to write multi-line strings in YAML](https://stackoverflow.com/a/21699210/1094085)
## Misc
- [**Feed.TXT**](https://feedtxt.github.io) - web feed format with meta data in YAML
- [**YAML @ Stackoverflow**](https://stackoverflow.com/tags/yaml/info) - frequently asked questions (and answers) about YAML
## Meta
**License**
The awesome list is dedicated to the public domain. Use it as you please with no restrictions whatsoever.
**Questions? Comments?**
Post them to the [wwwmake forum](http://groups.google.com/group/wwwmake). Thanks!