Markdown

Markdown is a way to style text on the web and it is intended to be as easy-to-read and easy-to-write as is feasible. You control the display of the document; formatting words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like # or *.

A Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters — including Setext, atx, Textile, reStructuredText, Grutatext, and EtText — the single biggest source of inspiration for Markdown’s syntax is the format of plain text email.

How to use Markdown

There are several Markdown editors and plugins available for all platforms and web browsers, both online and desktop versions, such as Typora, Dillinger, and StackEdit.

But you can use almost any simple text editor to write with Markdown, including OSX's TextEdit, Linux's Notepad++, or Windows' Notepad.

Syntax guide

There are different versions (processors) of Markdown, i.e different "flavours".

Gastby, the engine behind our website - and therefore behind our blog - uses a flavour called Remark.

Both our Style Guide and this Playbook use GitHub flavoured Markdown (by the way, both the Style Guide and the Playbook are built using GitBook).

There are several guides, tutorials, and references on how to use Markdown available online. We recommend checking GitHub's guide Mastering Markdown.

You might want to bookmark this complete list of github markdown emoji markup as well - although they don't work on GitBook 😕

Special notes

How to add captions to images

Use the reference below. You CANNOT leave a empty line between the two lines!

![imageTitle](./file.jpg)
_This is a small sentence about the image above._