Skip to content

Latest commit

 

History

History
155 lines (94 loc) · 3.46 KB

README.md

File metadata and controls

155 lines (94 loc) · 3.46 KB
Raw

Tou Logo

Tou is an open-source markdown editor for the web.

Heavily inspired by the excellent Mou editor for OS X.

Get the source code.

Hacking

First install Heroku's Toolbelt

$ git clone <your fork>
$ make # build virtualenv and install dependencies
$ make serve # runs the local server
$ heroku create --stack cedar
$ make deploy

Don't forget to source bin/activate if you need to do anything else :-)

Markdown Syntax

Strong and Emphasize

strong or strong

emphasize or emphasize

Sometimes I want a lot of text to be bold. Like, seriously, a LOT of text

Blockq

Right angle brackets > are used for block quotes.

Links and Email

An email [email protected] link.

Simple inline link http://www.google.com, another inline link Smaller, one more inline link with title Resize.

A reference style link. Input id, then anywhere in the doc, define the link with corresponding id:

Titles ( or called tool tips ) in the links are optional.

Images

An inline image Smaller icon, title is optional.

Inline code and Block code

Inline code is surrounded by backtick key. To create a block code:

Indent each line by at least 1 tab, or 4 spaces.
var Mou = exactlyTheAppIwant;

Ordered Lists

Ordered lists are created using "1." + Space:

  1. Ordered list item
  2. Ordered list item
  3. Ordered list item

Unordered Lists

Unordered list are created using "*" + Space:

  • Unordered list item
  • Unordered list item
  • Unordered list item

Or using "-" + Space:

  • Unordered list item
  • Unordered list item
  • Unordered list item

Hard Linebreak

End a line with two or more spaces will create a hard linebreak, called <br /> in HTML. ( Control + Return )
Above line ended with 2 spaces.

Horizontal Rules

Three or more asterisks or dashes:

Headers

Setext-style:

This is H1

This is H2

atx-style:

This is H1

This is H2

This is H3

This is H4

This is H5
This is H6

Extra Syntax

Strikethrough

Wrap with 2 tilde characters:

Strikethrough

Fenced Code Blocks

Start with a line containing 3 or more backticks, and ends with the first line with the same number of backticks:

Fenced code blocks are like Stardard Markdown’s regular code
blocks, except that they’re not indented and instead rely on
a start and end fence lines to delimit the code block.

Tables

A simple table looks like this:

First Header Second Header Third Header
Content Cell Content Cell Content Cell
Content Cell Content Cell Content Cell

If you wish, you can add a leading and tailing pipe to each line of the table:

First Header Second Header Third Header
Content Cell Content Cell Content Cell
Content Cell Content Cell Content Cell

Specify alignement for each column by adding colons to separator lines:

First Header Second Header Third Header
Left Center Right
Left Center Right