Markdown 语法

Markdown 语法和 MWeb 写作使用说明

Markdown 的设计哲学

Markdown 的目標是實現「易讀易寫」。

不過最需要強調的便是它的可讀性。一份使用 Markdown 格式撰寫的文件應該可以直接以純文字發佈,並且看起來不會像是由許多標籤或是格式指令所構成。

Markdown 的語法有個主要的目的:用來作為一種網路內容的寫作用語言。

本文约定

如果有写 效果如下:, 在 MWeb 编辑状态下只有用 CMD + 4CMD + R 预览才可以看效果。

标题

Markdown 语法:


# 第一级标题 `<h1>`

## 第二级标题 `<h2>`

###### 第六级标题 `<h6>`

效果如下:

第一级标题

第二级标题

第六级标题

强调

Markdown 语法:


*这些文字会生成`<em>`*

_这些文字会生成`<u>`_

**这些文字会生成`<strong>`**

__这些文字会生成`<strong>`__

在 MWeb 中的快捷键为: CMD + UCMD + ICMD + B

效果如下:

这些文字会生成<em>

这些文字会生成<u>

这些文字会生成<strong>

这些文字会生成<strong>

换行

四个及以上空格加回车。

如果不想打这么多空格,只要回车就为换行,请勾选:Preferences - Themes - Translate newlines to <br> tags

列表

无序列表

Markdown 语法:


* 项目一 无序列表 `* + 空格键`

* 项目二

* 项目二的子项目一 无序列表 `TAB + * + 空格键`

* 项目二的子项目二

在 MWeb 中的快捷键为: Option + U

效果如下:

  • 项目一 无序列表 * + 空格键

  • 项目二

  • 项目二的子项目一 无序列表 TAB + * + 空格键

  • 项目二的子项目二

有序列表

Markdown 语法:


1. 项目一 有序列表 `数字 + . + 空格键`

2. 项目二

3. 项目三

1. 项目三的子项目一 有序列表 `TAB + 数字 + . + 空格键`

2. 项目三的子项目二

效果如下:

  1. 项目一 有序列表 数字 + . + 空格键

  2. 项目二

  3. 项目三

  4. 项目三的子项目一 有序列表 TAB + 数字 + . + 空格键

  5. 项目三的子项目二

列表中嵌入代码块语法

1. 项目一 有序列表 `数字 + . + 空格键`

    列表中嵌入代码块必须前后空一行,如这个写法

    ```js

    function fancyAlert(arg) {

      if(arg) {

        $.facebox({div:'#foo'})

      }

    }

    ```

    其他文本。

2. 项目二

任务列表(Task lists)

Markdown 语法:


- [ ] 任务一 未做任务 `- + 空格 + [ ]`

- [x] 任务二 已做任务 `- + 空格 + [x]`

效果如下:

  • 任务一 未做任务 - + 空格 + [ ]

  • 任务二 已做任务 - + 空格 + [x]

图片

Markdown 语法:


![GitHub set up](http://zh.mweb.im/asset/img/set-up-git.gif)

格式: ![Alt Text](url)

Control + Shift + I 可插入Markdown语法。

如果是 MWeb 的文档库中的文档,还可以用拖放图片、CMD + V 粘贴、CMD + Option + I 导入这三种方式来增加图片。

效果如下:

GitHub set up

MWeb 引入的特别的语法来设置图片宽度,方法是在图片描述后加 -w + 图片宽度 即可,比如说要设置上面的图片的宽度为 140,语法如为 [图片上传失败...(image-99c4d8-1588823973129)]

GitHub set up-w140

链接

Markdown 语法:


email <example@example.com>

[GitHub](http://github.com)

自动生成连接  <http://www.github.com/>

Control + Shift + L 可插入Markdown语法。

如果是 MWeb 的文档库中的文档,拖放或CMD + Option + I 导入非图片时,会生成连接。

效果如下:

Email 连接: example@example.com

连接标题Github网站

自动生成连接像: http://www.github.com/ 这样

区块引用

Markdown 语法:


某某说:

> 第一行引用

> 第二行费用文字

CMD + Shift + B 可插入Markdown语法。

效果如下:

某某说:

第一行引用

第二行费用文字

行内代码

Markdown 语法:


像这样即可:`<addr>` `code`

CMD + K 可插入Markdown语法。

效果如下:

像这样即可:<addr> code

多行或者一段代码

Markdown 语法:


function fancyAlert(arg) {

  if(arg) {

    $.facebox({div:'#foo'})

  }

}

CMD + Shift + K 可插入Markdown语法。

效果如下:


function fancyAlert(arg) {

if(arg) {

$.facebox({div:'#foo'})

}

}

顺序图或流程图

Markdown 语法:


张三->李四: 嘿,小四儿, 写博客了没?

Note right of 李四: 李四愣了一下,说:

李四-->张三: 忙得吐血,哪有时间写。


st=>start: 开始

e=>end: 结束

op=>operation: 我的操作

cond=>condition: 确认?

st->op->cond

cond(yes)->e

cond(no)->op

效果如下( Preferences - Themes - Enable sequence & flow chart 才会看到效果 ):


张三->李四: 嘿,小四儿, 写博客了没?

Note right of 李四: 李四愣了一下,说:

李四-->张三: 忙得吐血,哪有时间写。


st=>start: 开始

e=>end: 结束

op=>operation: 我的操作

cond=>condition: 确认?

st->op->cond

cond(yes)->e

cond(no)->op

更多请参考:http://bramp.github.io/js-sequence-diagrams/, http://adrai.github.io/flowchart.js/

表格

Markdown 语法:


第一格表头 | 第二格表头

--------- | -------------

内容单元格 第一列第一格 | 内容单元格第二列第一格

内容单元格 第一列第二格 多加文字 | 内容单元格第二列第二格

效果如下:

第一格表头 | 第二格表头

--------- | -------------

内容单元格 第一列第一格 | 内容单元格第二列第一格

内容单元格 第一列第二格 多加文字 | 内容单元格第二列第二格

删除线

Markdown 语法:

加删除线像这样用: 删除这些

效果如下:

加删除线像这样用: 删除这些

分隔线

以下三种方式都可以生成分隔线:




效果如下:




MathJax

Markdown 语法:


块级公式:

$$  x = \dfrac{-b \pm \sqrt{b^2 - 4ac}}{2a} $$

\\[ \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} =

1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}}

{1+\frac{e^{-8\pi}} {1+\ldots} } } } \\]

行内公式: $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$

效果如下(Preferences - Themes - Enable MathJax 才会看到效果):

块级公式:

x = \dfrac{-b \pm \sqrt{b^2 - 4ac}}{2a}

\[ \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} =

1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}}

{1+\frac{e^{-8\pi}} {1+\ldots} } } } \]

行内公式: \Gamma(n) = (n-1)!\quad\forall n\in\mathbb N

脚注(Footnote)

Markdown 语法:


这是一个脚注:[^sample_footnote]

效果如下:

这是一个脚注:[1]

注释和阅读更多

Actions->Insert Read More Comment 或者 Command + .

阅读更多的功能只用在生成网站或博客时,插入时注意要后空一行。

TOC

Markdown 语法:


[TOC]

效果如下:

[TOC]


  1. 这里是脚注信息

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,214评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,307评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,543评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,221评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,224评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,007评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,313评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,956评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,441评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,925评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,018评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,685评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,234评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,240评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,464评论 1 261
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,467评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,762评论 2 345