Markdown

Markdown使用

一、介绍

考虑到周围不少同学不太了解markdown以及从未使用过markdown,这里对markdown进行一下介绍。我平时写公众号文章全部是使用markdown编写,之后使用相应的格式转换工具排版,比起word要方便很多(当然如果word用的很熟练的话自然是不比markdown差的,我就属于word用得不太利索的…)

markdown在平时的工作生活中有很多方便的使用场景,例如做笔记,进行项目记录,写报告等等。它可以让你暂时性忽略复杂的排版,仅仅从文章结构出发,通过一系列标记形成文本的结构,大家体验一下就知道他有多方便啦~

Markdown是一种轻量级标记语言,创始人为约翰·格鲁伯(John Gruber)。它允许人们使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档。这种语言吸收了很多在电子邮件中已有的纯文本标记的特性。

  • Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。
  • Markdown 编写的文档后缀为 .md, .markdown

二、编辑器

由于Markdown的轻量化、易读易写特性,并且对于图片,图表、数学式都有支持,目前许多网站都广泛使用Markdown来撰写帮助文档或是用于论坛上发表消息, 如GitHub、Stack Exchange、OpenStreetMap 、SourceForge、CSDN论坛、简书等,甚至还能被使用来撰写电子书。

编写Markdown的编辑器有很多,比如Typora,Sublmie Text等。一些博客网站也支持Markdown编写比如CSDN、简书等等,而且还有预览功能,Sublime Text好像没有预览功能,对于一些新入手Markdown的童鞋来说还是选择有预览功能的编辑器比较好。不过CSDN在插入图片的时候好像会自动给你加上你博客账户的水印,如果单纯写Markdown文件,加上水印就不太好了,所以大家可以下载专用的编辑器,比如Typora,就像编代码一样使用哈哈哈哈。除此之外,一些编程软件的集成开发环境也支持Markdown的编写,比如JetBrains全家桶,可以用来写帮助文档或则接口文档。

简书编辑页面

三、使用方法

标题

Markdown有两种标题表示方法:
(1)使用 = 和 - 标记以及和二级标题

用我来表示一级标题
=================

用我来表示二级标题
-----------------

(2)使用#标记
使用 #号可表示 1-6 级标题,一级标题对应一个 # 号,二级标题对应两个 # 号,以此类推。

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

用这种方式表示标题可以快速生成文章结构图,例如(下图右边)


段落

Markdown 段落没有特殊的格式,直接编写文字就好,段落的换行是使用两个以上空格加上回车。当然也可以在段落后面使用一个空行来表示重新开始一个段落。


从上图可以看到两个换行方式,第一行的换行就是两个空格加回车的换行方式,后面会有一个竖直向下的箭头;第二行就是使用一个空行表示重新开始的一个段落。其实直接回车也可以的哈哈哈哈。

字体

Markdown 可以使用以下几种字体:

*斜体文本*
_斜体文本_
**粗体文本**
__粗体文本__
***粗斜体文本***
___粗斜体文本___

是不是感觉很简单呢。

删除线和下划线

删除线可以用~~来标记,下划线可以使用html的<u>标签来标记:

Markdown删除线
~~Markdown删除线~~
Markdown下划线
<u>Markdown下划线</u>

脚注

脚注是对文本的补充说明。Markdown 脚注的格式如下:

[^要注明的文本]
示例:
创建脚注格式[^ 脚注]
[^ 脚注]: 这是一个脚注

当把鼠标移动到脚注上时,就会显示出脚注信息。

分割线

Markdown可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:

***

* * *

*****

- - -

----------

列表

Markdown 支持有序列表和无序列表:

无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记,这些标记后面要添加一个空格,然后再填写内容:

下面是列表
* 列表第一项
* 列表第二项
* 列表第三项

+ 列表第1.1项
+ 列表第2.2项
+ 列表第3.3项

- 列表第one项
- 列表第two项
- 列表第three项

可以发现列表都是自带缩进的。

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

hello
1. Firstly
2. Secondly
3. Thirdly

列表嵌套

列表嵌套只需在子列表中的选项前面添加四个空格即可:

1. 第一项:
    - 第一项嵌套的第一个元素
    - 第一项嵌套的第二个元素
2. 第二项:
    - 第二项嵌套的第一个元素
    - 第二项嵌套的第二个元素

区块

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

下面是区块
> 天长地久有时尽,此恨绵绵无绝期。
>
> 一个普通的改变也能改变普通。
>
> 我本将心向明月,奈何明月照沟渠

另外区块是可以嵌套的,一个 > 符号是最外层,两个 > 符号是第一层嵌套,以此类推:

> 天长地久有时尽,此恨绵绵无绝期
> > 一个普通的改变也能改变普通
> > > 我本将心向明月,奈何明月照沟渠

同样在列表中可以使用区块,在区块中也可以使用列表,这里就不再举例了,大家可以尝试一下。

代码

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

`System.out.println("hello, World");`

代码区块

代码区块使用 4 个空格或者一个制表符(Tab 键)或者使用三个反引号(`)把代码上下包起来:

​```
#include <iostream>
int main() {
    printf("hello,world");
    system("pause");
    return 0;
}
​```

链接

[链接名称](链接地址)
或者
<链接地址>
实例:
这是一个链接[西南大学](http://swu.edu.cn)
<http://swu.edu.cn>

Markdown还有一种高级链接方式,就是可以通过变量来设置一个链接,变量赋值在文档末尾进行。这个就不再详细讲了哈,大家感兴趣可以百度一下。

插入图片

Markdown插入图片也有专门的语法,但是一般都是直接把图片复制粘贴进编辑器即可,也可以直接截图粘贴进来,然后改一下图片名称即可。至于具体的语法就不在详细的讲了。

![alt 属性文本](图片地址)

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

表格

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

语法格式如下:

|  表头1   | 表头2  |
|  ----  | ----  |
| 单元格1  | 单元格2 |
| 单元格3  | 单元格4 |

我们可以设置表格的对齐方式:

  1. -: 设置内容和标题栏居右对齐。
  2. :- 设置内容和标题栏居左对齐。
  3. :-: 设置内容和标题栏居中对齐。
| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |

常用技巧

支持的 HTML 元素:

不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。目前支持的 HTML 元素有:<kbd> <b> <i> <em> <sup> <sub> <br>等 ,如:

使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑

转义字符:

Markdown 使用了很多特殊符号来表示特定的意义,如果需要显示特定的符号则需要使用转义字符,Markdown 使用反斜杠转义特殊字符。Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:

\   反斜线
`   反引号
*   星号
_   下划线
{}  花括号
[]  方括号
()  小括号
#   井字号
+   加号
-   减号
.   英文句点
!   感叹号

公式:

当你需要在编辑器中插入数学公式时,可以使用两个美元符 $$ 包裹 TeX 或 LaTeX 格式的数学公式来实现。提交后,问答和文章页会根据需要加载 Mathjax 对数学公式进行渲染。如:

$$
\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}
$$

熟练的话,用markdown敲公式可快了

除了上面讲的内容之外,Markdown还可以绘制画流程图、时序图(顺序图)、甘特图等图形。是不是感觉很不可思议。感兴趣的小伙伴可以在网上找一找如何绘制图形。

四、语法总结

Markdown语法 详解
* 标记斜体
** 标记粗体文字
# 一级标题 "#"后需加空格
## 二级标题 以此类推三级标题为三个“#”
[链接](URL地址) “[]”间为显示的超文本
![图片](图片地址) “[]”间为图片名
> 引用 ">"后需加空格
* 无序列表 “*” 后需加空格
1. 有序列表 数字后需加"."
``` 标记代码块

Markdown语法简洁、使用便捷。而且一般的编辑软件都有很好的用户图形界面,非常的好用,即便很久没有使用也能很快回忆起语法。

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

推荐阅读更多精彩内容