8000 Add section about YAML metadata (fixes #30) · rplabon/github-cheat-sheet@93051b9 · GitHub
[go: up one dir, main page]

Skip to content

Commit 93051b9

Browse files
author
Rafal Chmiel
committed
Add section about YAML metadata (fixes tiimgreen#30)
1 parent a61bae7 commit 93051b9

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ A collection of cool hidden and not so hidden features of Git and GitHub. This c
2424
- [Task Lists](#task-lists)
2525
- [Relative Links](#relative-links)
2626
- [Metadata and Plugin Support for GitHub Pages](#metadata-and-plugin-support-for-github-pages)
27+
- [Viewing YAML Metadata in your Documents](#viewing-yaml-metadata-in-your-documents)
2728
- [Rendering Tabular Data](#rendering-tabular-data)
2829
- [Diffs](#diffs)
2930
- [Rendered prose Diffs](#rendered-prose-diffs)
@@ -342,6 +343,13 @@ The Jemoji and jekyll-mentions plugins enable [emoji](#emojis) and [@mentions](h
342343

343344
[*Read more about repository metadata and plugin support for GitHub Pages.*](https://github.com/blog/1797-repository-metadata-and-plugin-support-for-github-pages)
344345

346+
### Viewing YAML Metadata in your Documents
347+
Many blogging websites, like [Jekyll](http://jekyllrb.com/) with [GitHub Pages](http://pages.github.com/), depend on some YAML-formatted metadata at the beginning of your post. GitHub will render this metadata as a horizontal table, for easier reading
348+
349+
![YAML metadata](https://camo.githubusercontent.com/47245aa16728e242f74a9a324ce0d24c0b916075/68747470733a2f2f662e636c6f75642e6769746875622e636f6d2f6173736574732f36343035302f313232383236372f65303439643063362d323761302d313165332d396464382d6131636432323539393334342e706e67)
350+
351+
[*Read more about viewing YAML metadata in your documents.*](https://github.com/blog/1647-viewing-yaml-metadata-in-your-documents)
352+
345353
### Rendering Tabular Data
346354
GitHub supports rendering tabular data in the form of `.csv` (comma-separated) and `.tsv` (tab-separated) files.
347355

0 commit comments

Comments
 (0)
0