Markdown is amazing, but is it perfect?

To write this post I'm using a thing called Markdown. It's a simply, fairly widely accepted, text markup language. It has a set of rules, and you use them to display things like headings, links, blockquotes, codeblocks, and other things people actually write online. For coders, it's great: it's HTML without the bullshit. But can it work in a company of people who deal with words, not code?

I'd like to see an example of it being used in the real world, with editorial staff and not tech staff.

Let's look at what markdown can do.

Code #

 var s = "JavaScript syntax highlighting";
 alert(s);

 s = "Python syntax highlighting"
 print s

No language indicated, so no syntax highlighting. 
But let's throw in a <b>tag</b>.

Links #

And it was super easy to bring accross an html page and convert it to partial markdown. You can see it here:

[Here is some space content.](https://rupert.dance/posts/space/)
Becomes
Here is some space content.

Text, headings and more #

Headings and texta are straightforward.

# H1
## H2
### H3

H2 #

H3 #

H4 #

etc

**bold text**
*italicized text*
> blockquote

1. First item
2. Second item
3. Third item

- First item
- Second item
- Third item

bold text
italicized text

blockquote

1. First item
2. Second item
3. Third item

• First item
• Second item
• Third item

Tables! #

The following markdown is rendered out below:

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

Colons can be used to align columns.

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.

← Home