Markdown syntax

Markdown is a text formatting syntax inspired on plain text email. In the words of its creator, John Gruber:

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.

Strong

  • Mac: + b
  • Win & Linux: Ctrl + b

strong and strong

**strong**
__strong__

Emphasize

  • Mac: + i
  • Win & Linux: Ctrl + i

emphasize and emphasize

*emphasize*
_emphasize_

Strikethrough

  • Mac: Alt + + x
  • Win & Linux: Alt + Shift + x

delete this text

~~delete this text~~

Links

  • Mac: + k
  • Win & Linux: Ctrl + k
[link text](https://url.com/ "title")
[link text](https://url.com/)
<https://url.com>

Learn more about links in Typlog.

Images

![alt text](https://path/to/img.jpg "title")

![alt text](https://path/to/img.jpg)

Image with "title" will be shown as <figcaption>.

Image Gallery is formatted by multiple image markup:

![alt](/img/src) ![alt](/img/src)
![alt](/img/src)

Learn more about images in Typlog.

Inline code

  • Mac: + e
  • Win & Linux: Ctrl + e

An inline code is marked with `.

`inline code`

Headers

Shortcuts for Mac
  • H1: Alt + + 1
  • H2: Alt + + 2
  • H3: Alt + + 3
  • H4: Alt + + 4
  • H5: Alt + + 5
  • H6: Alt + + 6
Shortcuts for Windows & Linux
  • H1: Alt +Shift + 1
  • H2: Alt +Shift + 2
  • H3: Alt +Shift + 3
  • H4: Alt +Shift + 4
  • H5: Alt +Shift + 5
  • H6: Alt +Shift + 6

Atx-style headers:

# h1
## h2
### h3
…

Closing # are optional.

# h1 #
## h2 ##
…

Lists

There are two types of list.

Ordered List

  • Mac: Alt + + o
  • Win & Linux: Alt + Shift + o

Ordered list without paragraphs:

  1. foo 2. bar
  2. baz
1. foo
   2. bar 
3. baz

Unordered List

  • Mac: Alt + + u
  • Win & Linux: Alt + Shift + u

Unordered list with paragraphs:

  • A list item.

    With multiple paragraphs.

  • bar

* A list item.

  With multiple paragraphs.

* bar

You can nest them:

* Abacus
  * anser
* Bubbles
  1. bunk
  2. bupkis
     * bar
  3. burper
* Cunning

Blockquotes

Email-style angle brackets are used for blockquotes.

  • Mac: Alt + + q
  • Win & Linux: Alt + Shift + q
> Email-style angle brackets
> are used for blockquotes.

> > And, they can be nested.

> #### Headers in blockquotes
> 
> * You can quote a list.
> * Etc.

Horizontal Rules

  • Mac: Alt + + Enter
  • Win & Linux: Alt + Shift + Enter

Three or more dashes for asterisks.


---
***

Manual Line Breaks

Shift + Enter

End a line with two or more spaces:

Roses are red,
Violets are blue.

Roses are red, [space][space]
Violets are blue. [space][space]

Block code

Block code should indent with 4 spaces:

    def hello():
        print('hello')
def hello():
    print('hello')

You can learn Fenced code in advanced markdown syntax.

Footnotes

Here is a footnote1. The key is better to be word-word style.

Here is a footnote[^key]. The key is better to be `word-word` style.

[^key]: Some explain for this footnote.

Typlog is powered by Mistune markdown parser.

  1. Some explain for this footnote.

Read more