简书Markdown语法 - 小记

这段时间看简书文章,自己也开始做笔记,记录自己的一些学习内容。刚开始也没多在意排版,就随便排版写,写完一两篇文章,当自己以游客的角度去看自己写的文章时,才发现自己文章的排版是那么不堪入目。于是我就开始查找原因。在简书上找到了自己目前比较满意的一篇文章。
此文章内容是转自:简书 Markdown 语法详解
还有一篇文章值得推荐看:Markdown 语法整理大集合2017

关于简书 Markdown

Markdown 语法的目标: 成为一种适用于网络的书写语言。
本文的目的:使读者轻松了解简书对 Markdown 语法的支持,了解其优点和不足。能够在选择时正确取舍,使用时得心应手。


一、区块标记

区块标记:是指内容独占一块,需前后换行,不和其他标记共处一行的标记。

1. 段落

段落:即是一段连续的文字,可包含*、空格、换行、tab等字符。两个段落之间使用空行分隔。

示例代码

第一自然段

第二自然段

效果

第一自然段

第二自然段

注意:换行不是分段的标识,空行才是

2. 标题

标题:代表了文章中主题的层次,比如:文章标题使用一级标题,回目名称使用二级标题,小节使用三级标题,依次类推。主题的层次代表了文章的大纲。

语法:Markdown 中使用连续的 n(1-6) 个 # 分别表示第 n 级标题。
示例代码

    # 一级标题
    ## 二级标题
    ### 三级标题
    #### 四级标题
    ##### 五级标题
    ###### 六级标题

效果

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

注:# 和后续内容之间应放置一个空格

3. 列表

列表:就是一组相关信息的集合。简书中的列表分为 有序列表无序列表

1) 有序列表

语法:使用 数字 + . 作为项目符号,项目符号和正式列表项目之间有一个空格。

示例代码

1\. 打开冰箱门
2\. 把大象放进冰箱
3\. 关上冰箱门

效果

  1. 打开冰箱门
  2. 把大象放进冰箱
  3. 关上冰箱门

2) 无序列表

语法:使用 * 作为项目符号,项目符号和正式列表项目之间有一个空格。

示例代码

* 吃饭
* 睡觉
* 打豆豆

效果

  • 吃饭
  • 睡觉
  • 打豆豆

注意事项

  • *无序列表的项目符号可使用 ,+,- 效果是相同的。
  • 列表与后续内容之间需要一个空行隔开,即:列表是一个段落
  • 列表允许多层次嵌套
  • 可以在项目中包含段落,只需将段落前添加一个 tab 或 4 个空格

4. 分割线

语法:使用 3 个连续的 * 即可得到一个分割线

示例代码

***

效果


5. 引用

语法:在行头加上 > 即可。

这里是一段引用

注意事项:

  • 大于号 和 文字必须有一个空格
  • 可以在每行之前加 > ,也可以在段落之前加 1 个 >
  • 引用内部可以使用其他 Markdown 标记

引用内部可以添加新的引用,只需再加一个大于号


二、行内标记

行内标记和其他标记共处一行。

1. 强调文字

1) 斜体

语法:使用前后各 1 个 *(或_) 包含的文字是 斜体 文字
示例代码

*斜体*, _斜体_

效果

斜体, 斜体

2) 粗体

语法:使用前后各 2 个 *(或_) 包含的文字是 粗体 文字
示例代码

**粗体**,__粗体__

效果

粗体粗体

3) 删除文字

语法:使用前后各 2 个 ~ 包含的文字是删除文字
示例代码

~~删除~~

效果

删除

4) 粗斜体

语法:(或_)中嵌套 (或) 或 在_(或)中嵌套**(或__)即可得到 粗斜体

示例代码

_**粗斜体**_, *__粗斜体__*
**_粗斜体_**, __*粗斜体*__

效果

粗斜体粗斜体
粗斜体粗斜体

2. 图片与链接

1) 图片:行内图片、引用图片

1> 行内图片
图片和图片地址写在一起。
语法: [图片上传失败...(image-47a801-1518246319069)]
示例代码

![史努比](http://upload-images.jianshu.io/upload_images/2779565-13b3439b110c16bf.jpeg?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

效果

史努比

注意事项

在简书中,图片可以直接拖到编辑区,会自动上传图片并生成图片地址。本功能是简书提供的一大便利,值得表扬!

2> 引用图片
图片和图片地址分开书写。
语法:
![图片标题][图片id]
[图片id]:图片url

示例代码:

![史努比][snoopy]
[snoopy]: http://upload-images.jianshu.io/upload_images/2779565-13b3439b110c16bf.jpeg?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240

效果

![史努比][snoopy]
[snoopy]: http://upload-images.jianshu.io/upload_images/2779565-13b3439b110c16bf.jpeg?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240
注意事项
引用图片的 id 在文章中必须唯一

2) 链接:行内链接、链接引用、自动链接

1> 行内链接
语法:[链接名称](链接地址 url "链接title")
示例代码

 [新浪](http://www.sina.com.cn "新浪主页")

效果

新浪

注意事项

双引号中的内容是链接的 title (目前汉字显示不正确)

2> 链接引用
一种链接和地址分离的方式。
语法:
[链接名称][链接id]
[链接id]:链接 url 地址 "链接 title"

示例代码

根据 [雅虎][yahoo] 的调查,希拉里将当选;根据 [谷歌][google] 的调查,川普将当选。

[yahoo]: http://search.yahoo.com/ "Yahoo Search"
[google]: http://google.com/ "Google"

效果
根据 雅虎 的调查,希拉里将当选;根据 谷歌 的调查,川普将当选。

注意事项

链接 id 可使用字母、数字、空格,但不区分大小写

3> 自动链接
一种简明的链接书写方式
语法:<链接地址>

示例代码

<http://www.sina.com.cn>

效果

http://www.sina.com.cn

3. 脚注

为名词提供注释,注释将显示在文章末尾。
语法:
待解释文字[^脚注 id]
[^脚注 id]:注释内容

示例代码

Hello程序[^hello]

[^hello]:即:Hello, world 程序

效果
Hello程序[1]

注意事项

  • 脚注 id 必须唯一
  • 无论脚注 id 如何起名,显示时一律标为数字,并且按出现顺序排列

三、双标记

既可作为区块标记又可作为行内标记的标记。

1. 代码块

1) 行内代码块

语法:使用两个 ` 将代码包含起来

示例代码

在 Java 输出 Hello, world :`System.out.print("Hello, World!");`

效果

在 Java 输出 Hello, world :System.out.print("Hello, World!");

2) 多行代码块

语法:只需要每行都缩进 4 个空格即可,或者使用```框起来。

示例代码 1 (行前4个空格)

// JQuery 的 Hello, world
$(function(){
alert("Hello, world!")
});

效果(行前4个空格)

// JQuery 的 Hello, world
$(function(){
    alert("Hello, world!")
});

示例代码 2 (```)

// JQuery 的 Hello, world
$(function(){
alert("Hello, world!")
});

效果 (```)

// JQuery 的 Hello, world
$(function(){
    alert("Hello, world!")
});

注意事项:

  1. 在代码区块内部,", <>,& 将会自动转换为转义字符
  2. 在代码区块内部,Markdown 标记将保持原样,即:星号()就是星号(),不被解释为特殊标记,这样就可以不能继续使用 Markdown 语法了**

四、表格

语法:

  1. 第一行为表头,第二行分隔表头和主体部分,第三行开始每一行为一个表格行。
  2. 列于列之间用管道符 | 隔开。表格每一行两边的管道符可省略。
  3. 第二行还可以为不同的列指定对齐方向。标题默认为居中对齐,内容默认为左对齐;在 - 左边加上 : 就是左对齐;在 - 右边加上 : 就是右对齐;在 - 两边都加上 : 就是居中对齐。

示例代码

姓名|语文成绩|数学成绩|总成绩
---|:---|:---:|---:
喜羊羊|100|120|220

效果

姓名 语文成绩 数学成绩 总成绩
喜羊羊 100 120 220

五、其他问题

1. Markdown 与 HTML 的关系

  1. HTML 是一种发布的格式,Markdown 是一种书写的格式。
  2. Markdown 的格式语法只涵盖纯文本可以涵盖的范围。
  3. 在 Markdown 中可直接使用 HTML 标签,但需要注意
  • 对于 HTML 区块元素――如 div、table、pre、p 等标签,必须在前后加上空行与其它内容区隔开,还要求它们的开始标签与结尾标签不能用制表符(tab)或空格来缩进
  • HTML 的行内标签——如 span、cite、del 可以在 Markdown 的段落、列表或是标题里随意使用。
  • 在 HTML 的区块标签中的 Markdown 标签是没有效果的

2. 特殊字符的自动转换

  • 在 HTML 文件中,有两个字符需要特殊处理: < 和 &,必须使用转义字符:& lt ; 和 & amp ;
  • Markdown 中,你可以自由的书写 < 和 &,编辑器会智能的进行判断:当这些符号用于 HTML 标签中,他们将保留原型;当他们单独使用时,将会转换为字符实体。
  • 在代码块中,它们将统统被转换为字符实体,即:原样显示。

3. Markdown 中的转义字符

Markdown 中,如需显示有特定意义的符号,如:*,# 等,可使用 反斜杠 \ 进行转义。可对如下字符进行转义:

*
`
*
_
{}
()
#
+
-
.
!  

六、简书尚不支持的标记和不足

  1. 用于生成目录索引的 [TOC]
  2. 用于说明文章标签的 tags
  3. 定义列表和待办事宜 Todo 列表
  4. 数学公式
  5. 各种图形:流程图、时序图、甘特图
  6. 其他技术,如:{mermaid}
  7. 区块代码中不显示行号

七、给简书的一点建议

  1. 对于普通用户来讲,定义列表、生成目录索引和文章标签功能是十分必要的,希望能够尽快增加这些功能。希望能够实现预览图和编辑器的同步滚动功能。
  2. 对于理工狗来讲,编辑 LaTex 数学公式是非常必要的功能,希望能够尽快增加这个功能。
  3. 对于代码狗来讲,区块代码中显示行号,以及流程图、时序图是非常必要的功能,希望能够尽快增加这些功能。
  4. 其他的诸如:待办事宜列表、甘特图,mermaid等功能,可以慢慢实现。

作者:白老师课堂
链接://www.greatytc.com/p/4e3cae082b47
來源:简书
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。

八、补充点

  1. Markdown换行,使用br标签。
    示例:
    第一段<br>第二段<br><br>第三段<br><br><br>第四段
    
    效果:
    第一段
    第二段

    第三段


    第四段

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

推荐阅读更多精彩内容