markdown

Standard

  • 代码直接缩进,不用标记包围也行,如果需要发表,再作处理,如需要高亮
  • 引用是内联式标记,要有换行
  • 使用 4 个空格缩进,尤其是在用嵌套列表时

Write better Markdown - BrettTerpstra.comopen in new window

GFM

  • [ ] @mentions, #refs, links, formatting, and tags supported
First HeaderSecond Header
Content from cell 1Content from cell 2
Content in the first columnContent in the second column
- dontDoThisThing()
+ doThisInstead()

辅助工具

表格生成,支持粘贴 xls/csv 内容(菜单 File-Paste) Markdown Tables generator - TablesGenerator.comopen in new window

markdown 与其他格式互转 Markdown 表格 编辑和生成器 - 在线表格转换工具open in new window

Vim 配合

特性markdown-previewTypora
触发:MarkdownPreview<leader>tp
实时反馈1
侧栏 Toc1

Gitbook

与 GFM 不一致的一些地方

.号作前导缩进

换行要用双空格

语法参考

function syntaxHighlighting() {
  var n = 33
  var s = 'hello, こんにちは'
  console.log(s)
}
  • plain
  • strikethrough
  • inline code
  1. Numbered list
    1. Numbered sub-list
      1. Numbered sub-sub-list
  2. Linkopen in new window

An image: Markdown Here logo

Block quote. With some markdown.

If TeX Math support is enabled, this is the quadratic equation: $-b \pm \sqrt{b^2 - 4ac} \over 2a$

Header 1

Header 2

Header 3

Header 4

Header 5
Header 6
TablesAreCool
column 3 isright-aligned$1600
column 2 iscentered$12
zebra stripesare neat$1

Here's a horizontal rule:


code block
with no highlighting
const a = 1

Using Markdown in Vimopen in new window

Last Updated:
Contributors: cyio