What’s Markdown?

When you see the 'Markdown-mark' it means Markdown is supported.

Markdown is a text-to-HTML conversion tool for writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to valid HTML.

Before you start

You’ll need Xcode, Homebrew and pandoc installed on your Mac (it’s easy, trust me 😈).

The code

note: If you need a reference for the keyboard symbols used below, see Apple Keyboard Symbols

  1. hit ⌘ space and type ‘Terminal’, followed by ↩︎

  2. at the prompt type pandoc

    If no input-file is specified, input is read from stdin.

  3. paste or type the text below at the prompt, then ↩︎ followed by ⌃-D:

# My First Markdown

That was a header, this is a paragraph.

The following is a list:

1. item 1
2. item 2
3. item 3

It’s that simple. Pandoc will read the text input, convert your markdown to HTML (and much more). The following is the output produced from the markdown example above:

<h1 id="my-first-markdown">My First Markdown</h1>
<p>That was a header, this is a paragraph.</p>
<p>The following is a list:</p>
<ol style="list-style-type: decimal">
    <li>item 1</li>
    <li>item 2</li>
    <li>item 3</li>
</ol>

Markdown and pandoc can do a lot more than just take text from stdin and turn it into HTML. To learn more about using Markdown, I recommend reading GitHub’s Mastering Markdown and Pandoc’s User Manual.