我的 MarkDown 学习笔记

时间:2023-02-04 16:20:08

MarkDown 一种用于写作的轻量级【标记语言】。它用简洁的语法代替排版,而不像一般的文字处理软件 Word 或者 Pages 有大量的排版、字体设置等。

如果你对文章的样式没有太多要求,只注重写文章本身的话 MarkDown 将会是一个不错的选择。

一、工具

支持 MarkDown 写作的软件有很多,因为国外平台的国内访问大都不太稳,这里就列举几个国内常用的:

  • 简书 博客平台,书写的时候每隔几秒钟就会自动备份一次,需要注册才能使用。

  • 马克飞象 付费软件,对于映像笔记用户来说是个不错的选择。

  • Cmd MarkDown 作业部落的产品,跨平台,支持 Windows、Linux、Mac 和 Web。而且提供了备份等功能。

  • Atom 著名的 Github 推出的编辑器,功能强大,支持原生实时预览。实时预览快捷键 ctrl+shift+m 。

二、基本语法

MarkDown 对于标题呀、字体呀等可能有多种写法。个人建议初学的时候记忆一种语法就好,待熟练后若有兴趣可多记几种。

1.标题

MarkDown 支持 1~6 级标题,通过加在标题文字前的 # 来区分。例如,

# 这是一级标题
## 这是二级标题
...
###### 这是六级标题

Tips: # 和标题文字之间是有一个空格的。

2.段落

很简单,一行文字就是一个段落。例如,

这是一行文字,MarkDown 中的段落。

如果要换行,那么两行之间要隔一个空行。例如,

这是一行文字,MarkDown 中的段落。
//这行是空行
这是另一行文字,MarkDown 中的段落。

3.粗体和斜体

Markdown 中字体的粗体和斜体用 ** * ** 表示。例如,

*这里是斜体*
**这里是粗体**
***这里是粗体 + 斜体***

效果如下:

这里是斜体

这里是粗体

这里是粗体 + 斜体

4.删除线

可能有一部分编辑器不支持这个元素。删除线用 ~ 定义。例如,

~~这里有删除线~~

效果如下:

这里有删除线

Tips: 删除线要用两个 ~ 来包裹文字。

5.引用

在一行文字前添加大于号 > 来使用引用格式。例如,

>这里是引用句子。

效果如下:

这里是引用句子。

引用可以嵌套使用,例如:

>>这里使用了嵌套引用。

效果如下:

这里使用了潜逃引用。

也可以嵌套其他格式。例如,

> ## 嵌套一个二级标题。
> *嵌套斜体字。*
> **嵌套粗体字。**

效果如下:

嵌套一个二级标题。

嵌套斜体字。

嵌套粗体字。

6.列表

列表分为无序列表和有序列表。

无序列表使用加号、减号和星号来标记。例如,

+ 加号列表
+ 加号列表
+ 加号列表 + 减号列表
+ 减号列表
+ 减号列表 + 星号列表
+ 星号列表
+ 星号列表

效果如下:

  • 加号列表

  • 加号列表

  • 加号列表

  • 减号列表

  • 减号列表

  • 减号列表

  • 星号列表

  • 星号列表

  • 星号列表

有序列表使用数字加上英文句点标记。

1.有序列表
2.有序列表
3.有序列表

7.内联代码

内联代码用反引号 ` 表示。例如,

`code`

有的地方说用单个 ` 即可表示内联代码,由于我用的是 Atom 编辑器,
单个 ` 不起作用,只好用两个 ` 将代码包裹起来。如果代码中有反引号 ` ,
也可以两个反引号将它包裹起来,但是要加空格。例如, ` ` `

效果如下:

code

`

8.代码块

有两种风格,原生和 Github 。

原生风格,首行缩进四个空格。例如,

这是一个普通段落。

    这是一个代码块。

效果如下:

这是一个普通段落。

这是一个代码块。

Github 风格,代码块的前后用三个反引号独占一行来标记。效果如下,

这里是代码块。

9.分割线

分割线可以用三个以上的星号、减号或者底线来标识,行内不能有其他东西,但是可以插入空格。例如,

***

* * *

---

- - -

___

_ _ _

效果如下:







10.链接

链接用下面的格式标识。例如,

[链接要显示的文字](http://www.zhihu.com "鼠标箭头放到链接上的提示文字,可以不写,与链接之间留有空格")

效果如下:

链接要显示的文字

还可以用另外的格式标识,

[链接要显示的文字][id]

在任意空白位置,

[id]:http://www.zhihu.com "鼠标箭头放到链接上的提示文字,可以不写,与链接之间留有空格"

效果也是一样的,

链接要显示的文字

11.自动链接

如果链接的地址和要显示的文字一样的话,可以用尖括号将其包裹形成自动连接。例如,

<http://www.zhihu.com>

效果如下:

http://www.zhihu.com

12.图片

图片的标识与链接类似。语法如下,

![图片不存在时的提示文字](http://images.cnblogs.com/cnblogs_com/zhangyn/922022/o_%e6%89%8b.jpg "鼠标箭头放到图片上的提示文字")

效果如下:

我的 MarkDown 学习笔记

![图片不存在时的提示文字][imgid]

[imgid]:http://images.cnblog.com/cnblogs_com/zhangyn/922022/o_手.jpg "鼠标箭头放到图片上的提示文字"

图片的 MarkDown 标识与 HTML 标签有对应的关系,关系如下,

![img alt 属性](img 地址 “img title 属性”)

<img src='img 地址' alt='img alt 属性' title='img title 属性'>

13.转义

支持在前面插入反斜杠转义的字符如下,

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

效果如下:

\ 反斜线

` 反引号

* 星号

_ 底线

{} 花括号

[] 方括号

() 括弧

# 井字号

+ 加号

- 减号

. 英文句点

! 惊叹号

14.表格

原本是 Github 风格的语法,大部分编辑器都支持。

| 键 | 值 | 备注 |
|----|----:|:------:|
|MacBookPro|¥12000|办公用品|
|打印机|¥12000|办公用品|
|台式电脑|¥12000|办公用品|

效果如下:

备注
MacBookPro ¥12000 办公用品
打印机 ¥1200 办公用
台式电脑 ¥120

Tips:第一行表头可以不要,第二行必须要有,第二行的冒号标识表中内容居左、居右还是剧中,如果不加冒号默认居左。

15.**内嵌 HTML **

MarkDown 保留了内嵌 HTML 的语法,标签中的内容都会输入到结果中。例如,

<html>
<body>
<iframe frameborder="no" border="0" marginwidth="0" marginheight="0" width=330 height=86 src="//music.163.com/outchain/player?type=2&id=64517&auto=0&height=66"></iframe>
</body>
</html>

效果如下:

竟然没显示出来zz....

16.目录

只要按照 MarkDown 语法书写,在需要生成目录的地方写[TOC] 就可以生成目录了。

三、综述

至此,就可以用 MarkDown 来写一般的文章啦。当然,如果有特殊的需求,比如:输入公式或者画 UML 图,那么可以参考下面的链接:

MarkDown Tex 公式输入语法参考

MarkDown 时序图语法参考

MarkDown 流程图语法参考