Viewing YAML Metadata in your Documents

Many blogging websites, like Jekyll with GitHub Pages, depend on some YAML-formatted metadata at the beginning of your post. You know, the stuff that goes between dashes like this:

title: Blogging Like a Boss

Starting today, we’ll render this metadata within GitHub as an horizontal table, for easier reading:

Example of rendered YAML frontmatter

This rendering works for any prose document that GitHub supports, so you don’t need to use Jekyll or Markdown for this to appear. Check out github/markup for a full list of which prose documents we support.

Happy writing!

Have feedback on this post? Let @github know on Twitter.
Need help or found a bug? Contact us.



Discover new ways to build better

Try Marketplace apps free for 14 days

Learn more