2019-07-07 Markdown使用教程

1. 什么是Markdown?

Markdown 是一种非常简单的、轻量级的标记语言。用户可以使用简单的标记符号以最小的输入代价去生成极富表现力的文档。Markdown 的语法简洁明了、学习容易,功能比纯文本强得多,因此有很多人用它写博客、写文档。

2. Markdown优点

  • 易读(看起来舒服)、易写(语法简单)、易更改(纯文本),可以方便地纳入版本控制;
  • 格式转换方便,Markdown 的文本可以轻松转换为 HTML、PDF、Word、图像、Epub 等文件;
  • 语法简单,没有什么学习成本,能轻松在码字的同时做出美观大方的排版。

3. 使用场景

  • 各类代码托管平台
    主流的代码托管平台,如 GitHub、GitLab、BitBucket、Coding、Gitee 等等,都支持 Markdown 语法,很多开源项目的 README、开发文档、帮助文档、Wiki 等都用 Markdown 写作。

  • 技术社区和写作平台
    StackOverflow、CSDN、掘金、简书、GitBook、有道云笔记

  • 论坛
    V2EX、光谷社区

4. 如何使用Markdown

Markdown基础语法主要包括以下内容:
标题、段落格式、列表、区块、代码、链接、图片、表格

4.1 标题

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

效果:

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

4.2 段落格式

4.2.1 字体

斜体文本

粗体文本

粗斜体文本

4.2.2 分隔线

-------
*********

效果:



4.3 列表

4.3.1 有序列表

有序列表使用数字并加上 . 号来表示

1. 第一项
2. 第二项
3. 第三项

4.3.1 无序列表

无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记

  • 第一项
  • 第二项
  • 第三项

4.4 区块

区块引用是在段落开头使用 > 符号 ,然后后面紧跟一个空格符号:

区块引用
菜鸟教程
学的不仅是技术更是梦想

4.5 代码

如果是段落上的一个函数或片段的代码可以用反引号把它包起来(`),例如:printf()

``` 包裹一段代码,并指定一种语言(也可以不指定):

$(document).ready(function () {
    alert('RUNOOB');
});

4.6 链接

链接名称
goole地址:google

4.7 图片

开头一个感叹号 !
接着一个方括号,里面放上图片的替代文字
接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上选择性的 'title' 属性的文字。

[图片上传失败...(image-33f202-1563182632593)]

4.8 表格

使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。

表头 表头
单元格 单元格
单元格 单元格

还可以设置对齐方式:

表头 表头 表头
单元格 单元格 单元格
单元格 单元格 单元格

5. 高级技巧

包括流程图,公式编辑器等

\mathbf{V}_1 \times \mathbf{V}_2 = \begin{vmatrix} \mathbf{i} & \mathbf{j} & \mathbf{k} \\ \frac{\partial X}{\partial u} & \frac{\partial Y}{\partial u} & 0 \\ \frac{\partial X}{\partial v} & \frac{\partial Y}{\partial v} & 0 \\ \end{vmatrix}

5. 编辑工具

理论上任何一款文本编辑器都能用于编辑 Markdown 文档,它们分别提供了不同程度的语法高亮、预览等功能,以下只是列举其中一部分,选择自己称手的即可。

  • 现代编辑器
    VSCode / Atom

  • 传统编辑器
    Vim / Emacs / Sublime Text / Notepad++

  • IDE 自带编辑器
    IntelliJ IDEA / Android Studio / WebStorm

  • 专用编辑器
    Ulysses / Mou / Typora / Markpad

  • 在线编辑器
    各种支持 Markdown 的网站都提供了在线编辑器,CSDN、简书、有道云笔记等

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

推荐阅读更多精彩内容