Editorial is optimized for writing Markdown, a popular plain text format that is very readable, and works well for writing on the web.
In the words of John Gruber, the inventor of Markdown:
The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that 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, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email.
The following is just a quick overview of how you can format your text using Markdown. For all the details, please refer to the syntax reference on the official Markdown project page.
Paragraphs in Markdown are separated by blank lines. A single line break does not result in a new paragraph.
Headers are marked with one or more hash characters. Example:
# This is a Level 1 Heading
## This is a Level 2 Heading
Markdown also supports using “Setext-style” headers (underlining the header with === or ---), but this is currently not supported by Editorial’s inline preview. It does work in the full HTML preview however.
Blockquotes are indicated by a leading > character, like in plain text email. Example:
> Any intelligent fool can make things bigger, more complex, and more violent.
> It takes a touch of genius -- and a lot of courage -- to move in the
> opposite direction.
> – Albert Einstein
You can use asterisks, plus symbols or hyphens as list markers for unordered lists. Example:
* Apple
* Banana
* Cherry
Ordered lists use numbers followed by periods. Example:
1. Red
2. Green
3. Blue
The actual numbers are not important for the output.
Code blocks can be formatted by indenting a paragraph with 4 or more spaces (or one tab). Example:
This is a normal paragraph.
This is a code block.
The inline preview uses a monospace font for code blocks.
Inline code is enclosed in a pair of backtick characters. Example:
You can use the `markdown` or `markdown2` modules to parse Markdown in Python.
There are two styles of links in Markdown: inline and reference. The link text is always enclosed in square brackets. Inline links contain the URL in parentheses, directly after the title:
[Inline Link](http://example.com)
A reference link uses a second set of square brackets and an arbitrary identifier instead of a URL. The identifier can be defined anywhere else in the document:
[Reference Link][1]
Some other text
[1]: http://example.com
Markdown uses one, two, or three asterisks (*) or underscores (_) for emphasizing text. Example:
*This is italic*
**This is bold**
***This is bold and italic***
Images have the same syntax as links, except that an exclamation mark is added. Example:
