最实用的 Markdown 语法教程

Markdown

前言

最近公司事情不多,每个项目组的人手都够,我这边事情不是很忙。因此,老大让我对Markdown语法做一个系统的培训。接到任务的时候,我就有点小小激动,终于有“用武之地”了。废话少说,咱们开始正题吧〜

执行概要

培训内容:

  1. Markdown 是什么?
  2. Markdown 是谁创造的?
  3. 为什么要使用Markdown?
  4. Markdown怎么使用?
  5. Markdown 都有哪些人在用?
  6. 尝试一下Markdown的使用!
  7. Markdown 进阶语法!

学习目标

通过学习,能对Markdown语法有个比较全面的认知,对日常工作写作排版尽量放弃Word、txt等文本工具,改直接用Markdown语言写文档。

学思路

  1. 一开始,先记住 # 这是标题## 这是二级标题### 这是三级标题、...这时候你写一般小文章会开始感觉 MD 不错。
  2. 然后,你发现标题不适合做列表,记住了用1. 第一点- 这一点来列表超级方便。
  3. 好吧,写作总要有些重点吧,**加粗***斜体*~~删除线~~开始派上用场了。这时你基本不会打开 Word 那样的笨重软件了。
  4. 如果你不幸是码农:
    \这是单行代码``

//这是代码段,四个空格或一个制表符缩进
int i;

> 这是引用
  1. 你越来越喜欢,自然会去查查维基(Markdown)还有什么语法,加上多用,很快就基本掌握了。MD 还有表格、锚、注脚、贴图等。强烈推荐 Mou,按 ⌘+R 可以快速查看语法。

  2. 慢慢,你会发现,总有小「bugs」,如列表内无法内嵌代码段。上网查查,你开始理解 MD 的缩进内嵌机制等高级隐形内容,这样你就 Master 了!

以下是 Mou 下面的效果,多么漂亮:


Mou 写出的效果

正文

一、Markdown是什么?

Markdwon 是一种轻量级 标记语言,它以纯文本形式(易读、易写、易更改)编写文档,并最终以HTLM格式发布。Markdown也可以理解为将以 MARKDOWN语法编写的语言转换成HTML内容的工具。

二、Markdown是谁创造的?

它是由 Aaron Swartz 和 [John Gruber](https://baike.baidu.com/item/John Gruber/18550453?fr=aladdin) 共同设计, Aaron Swartz 就是那位(2013年1月11日)自杀,有着开挂一般人生经历的程序员。 维基百科对他的介绍是:软件工程师作家政治组织者互联网活动家维基百科人

他有着足以让你跪拜的人生经历。

  • 14岁参与RSS 1.0规格标准制订。
  • 2004年入读斯坦福大学,之后退学。
  • 2005年创建 Infogami,之后与Reddit合并成为其合伙人。
  • 2010年创立示进会(Demand Preogress),积极参与禁止网络盗版法案(SOPA)活动,最终该提案被撤回。
  • 2011年7月19日,因被控从MIT和JSTOR下载480万篇学术论文并以免费形式上传于网络被捕。
  • 2013年1月自杀身亡。
    Aaron Swartz 大神照片

三、为什么要使用Markdown?

  • 它是易读(看起来舒服😌)、易写(语法简单)、易更改(纯文本)。处处体现着极简主义的影子。
  • 兼容HTML,可以转换为HTML格式发布。
  • 跨平台使用。
  • 越来越多的网站支持Markdown.
  • 更方便清晰的组织你的电子邮件。(Markdown-here,Airmail)。
  • 摆脱Word,txt!!!

四、Markdown怎么使用?

如果不算扩展,Markdown的语法绝对简单到让你爱不释手!

Markdown语法分为如下几大部分:

标题
段落
区块引用
代码区块
强调
列表
分割线
链接
图片
反斜杠
符号
表格
流程图

4.1 标题

两种形式
1)使用=-,标记一级二级 标题。

示例md代码:

一级标题
=
二级标题
-

示例效果:

效果图

2)使用 #,可以表示 1-6级 标题。

示例md代码:

# 第一级标题 `<h1>` 
## 第二级标题 `<h2>` 
### 第三级标题 `<h3>` 
#### 第二四级标题 `<h4>` 
##### 第五级标题 `<h5>` 
###### 第六级标题 `<h6>` 

示例效果:

效果图
4.2 段落

段落的前后要有空行,所谓的空行是指没有文字内容。若想在段内强制换行的方式是使用两个以上空格加上回车(引用中换行省略回车)

4.3 区块引用

在段落的每行或者只在第一行使用符号 > ,还可使用多个嵌套引用,如:

示例md代码:

> 区块引用
> > 嵌套引用
> > >三嵌套引用
> > > > 四嵌套引用

示例效果:

效果图
4.4代码区块

代码区块的建立是在每行加上4个空格或者一个制表符(如同写代码一样)。如普通段落:

示例md代码:

fun main(args: Array<String>) {
   println("Hello World!")

   println("sum = ${sum(34, 67)}")
   println("sum = ${sum(34, 67)}")
   println("sum = ${sum(34, 6, 57, 34)}")

   printSum(237, 57)
   printSum(234, 567, 8)
   vars(1, 4, 6, 78, 0, 6, 9, 8)


   val sumLambda: (Int, Int) -> Int = { x, y -> x + y }
   println("sumLambda = ${sumLambda(3, 6)}")


//    if (args.size < 2) {
//        println("Two integers expected")
//        return
//    }
   testFor()


   val a: Int = 1000
   println(a === a)//true 值相等,对象地址相等

   //经过了装箱,创建了两个不同的对象
   val boxedA: Int? = a
   val anotherBoxedA: Int? = a

   //虽然经过了装箱,但是值是相等的,都是10000
   println(boxedA === anotherBoxedA) //  false,值相等,对象地址不一样
   println(boxedA == anotherBoxedA) // true,值相等
}

示例效果:

效果图

注意⚠️:需要和普通段落之间存在空行!

4.5 强调

在强调内容两侧分别加上 *或者 -,如:

示例md代码:

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

示例效果:

效果图
4.6 列表 (有序,无序)

使用 .+、或- 标记无序列表,如:

示例md代码:

-   第一项
+   第二项
-   第三项
+   第四项
-   第五项
+   第六项

示例效果:

效果图
**注意:标记后面最少有一个_空格_或_制表符_。若不在引用区块

中,必须和前方段落之间存在空行。**

<font color ="red">示例md代码:</font>

 1. 第一项
 2. 第二项
 3. 第三项
 4. 第四项
 5. 第五项
 6. 第六项

示例效果:

效果图
4.7 分割线

分割线最常使用就是三个或以上的 *======</font>还可以使用 -_

示例md代码:

***
---
_____ 
======

示例效果:

效果图
4.8链接

链接可以由两种形式生成,行内式参考式

行内式:

示例md代码:

[GitHub](http://github.com)
自动生成连接  <http://www.github.com/>

示例效果:

效果图

参考试:

[GitHub][1]
[1]:http://github.com
自动生成连接  <http://www.github.com/>

示例效果:

效果图

注意:上述的 [1]:http://github.com 不出现在区块中。

4.9 图片

添加图片形式和链接相似,只需要在链接的基础上前方加一个 号。

示例md代码:

![GitHub set up](http://zh.mweb.im/asset/img/set-up-git.gif)
格式: ![Alt Text](url)
GitHub set up
4.10 反斜杠 ''

相当于反转义作用。使符号成为普通符号。

4.11 符号 ``

起到标记作用,如标签:

Ctrl+ACtrl+CCtrl+V

4.12 表格

示例md代码:

第一格表头 | 第二格表头
---------| -------------
内容单元格 第一列第一格 | 内容单元格第二列第一格
内容单元格 第一列第二格 多加文字 | 内容单元格第二列第二格
内容单元格 第一列第三格 多加文字 | 内容单元格第二列第三格
内容单元格 第一列第四格 多加文字 | 内容单元格第二列第四格

示例效果:

效果图
4.12 流程图
示例
st=>start: Start:>https://www.jpjbp.com/
io=>inputoutput: verification
op=>operation: Your Operation
cond=>condition: Yes or No?
sub=>subroutine: Your Subroutine
e=>end

st->io->op->cond
cond(yes)->e
cond(no)->sub->io
更多语法参考:流程图语法参考

五、Markdown都哪些人在用?

Markdown 的使用作者:

  • Github
  • 简书
  • StackOverFlow
  • Apollo
  • Moodle
  • Reddit
  • CSDN
  • 等等

六、尝试一下Markdown的使用!

  • Chrome下的插件诸如stackedit与markdown-here等非常方便,也不用担心平台受限。
  • 在线的dillinger.io评价也不错
  • Windowns下的MarkdownPad也用过,不过免费版的体验不是很好
  • Mac下的Mou是国人贡献的,口碑很好。
  • Linux下的ReText不错。

>>>Github传送门

TOC

Markdown 语法:

[TOC]

总结:

通过这次学习,自己也对MD语法有一个全新的认识,万事开头难,只要你偿试用MD 写工作中的文档,从此告别Word ,TXT!!!我相信你也会喜欢上这门语言。此外,如有写的不对的地方,勿喷!!! 欢迎指正!

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

推荐阅读更多精彩内容

  • 在简书中首先要打开设置界面看下编辑的模式什么如何的请选择Markdown语法 MarkDown语法开始 一级标题 ...
    峰子1994阅读 626评论 0 0
  • 欢迎关注微信公众号:北岛向南(id:nanzhouie) GitHub Pages:https://zhouie....
    zhouie阅读 4,812评论 4 72
  • Markdown 语法 之剑 2016.5.3 23:41:46 hljs.initHighlightingOnL...
    光剑书架上的书阅读 1,622评论 1 5
  • 我愿一片空白,然后被你一点点画满 你要用怎样一支画笔 对你充满期待 许久才知道你是在练习 画笔太多已眼花手乱 ...
    eaa1db538601阅读 287评论 0 0
  • 关爱,关心和爱。 如果父母没有给孩子真正的爱,如果夫妻之间没有爱,要培养孩子爱的品质是相当难的,甚至是难以实现的。...
    小红帽来了阅读 147评论 0 2