Skip to content

Instantly share code, notes, and snippets.

@dapperfu
Created May 3, 2018 15:31
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 1 You must be signed in to fork a gist
  • Save dapperfu/cf80624e70742d8333e92183be145d94 to your computer and use it in GitHub Desktop.
Save dapperfu/cf80624e70742d8333e92183be145d94 to your computer and use it in GitHub Desktop.
TUT017 Example YAML to MD.

active: true derived: false level: 1.5 links:

  • REQ004: 94f4db8d1a50ab62ee0edec1e28c0afb normative: true ref: '' reviewed: 98ba42c551fec65d9796fee72d15f844 title: Tutorial Requirement 17 author: Frey, Jed ...

Headings 3

Markdown can be used to format text.

Heading 4

Heading 5

Emphasis

Emphasis, aka italics, with asterisks or underscores.

Strong emphasis, aka bold, with asterisks or underscores.

Combined emphasis with asterisks and underscores.

Strikethrough uses two tildes. Scratch this.

Paragraphs

When exporting to html using doorstop newlines are converted to line breaks.

An empty line is required to start a new paragraph.

Lists

  1. First ordered list item
  2. Another item
  3. Actual numbers don't matter, just that it's a numbers
  • Unordered list can use asterisks
  • Or minuses
  • Or pluses

Tables

Colons can be used to align columns.

Tables Are Cool
col 3 is right-aligned $1600
col 2 is centered $12
zebra stripes are neat $1

There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown.

Markdown Less Pretty
Still renders nicely
1 2 3
@ngbrown
Copy link

ngbrown commented May 13, 2018

You actually got the ending of the YAML block wrong. It should be --- instead of ... Look at my fork of this file https://gist.github.com/ngbrown/eabd77b05d7f23336bae32144e5f9937 for the correctly formatted version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment