5分钟学会 markdown

简介: 5分钟学会 markdown

什么是 Markdown?


简介


markdown 是一种简洁的标记语言。通过简单的标记就可以让文字具有一定的排版。

markdown 是最受欢迎的标记语言之一,它比传统的 html 更加简洁。非常多的博客都是基于 markdown 来写的,本博客也是使用 markdown 来写的。

markdown 有很多衍生版本,支持了很多扩展功能。比如表格、角注、甚至可以内嵌 html 、画甘特图、流程图、渲染 mdx 等。不过我不是很建议使用这些扩展功能。

markdown 文件采用 .md 或者 .markdown 作为后缀。推荐只使用 .md 作为文件后缀。


创始人


约翰·格鲁伯


发明时间


2004 年


用途


可以用来写作、写笔记、博客、电子邮件、说明文档、学术论文等。

总之,凡是可以使用 txt 或者 word 来写的东西,markdown 都可以取代。


通用规范


这篇文章足以让你轻松入门markdown,如果意犹未尽,可以查看官方规范。

官方规范:commonmark.org/


markdown 编写工具


markdown 不需要使用某些特定的东西来编写,和 html 一样,可以使用任何文本编辑器编写。

但是考虑到编写效率和编写体验,建议使用某些专业的 markdown 编辑器来编写。如果是一个 markdown 新手,对 markdown 语法不是很熟悉,那么更加需要一款顺手的编辑器。

下面列举几个我最推荐的 markdown 编辑器:


离线工具


typora

最推荐的 markdown 编辑器。支持 windows、mac OS(目前是内测,但个人使用过程中没发现有严重的问题)、linux。

个人认为是最好用的 markdown 编辑器,免费开源而且跨平台。

和其它markdown编辑器不同的是它采用的是即时渲染技术,不需要同时开启一个编辑区域和一个预览区域,所见即所得。

官网:www.typora.io/

vscode

vsocde 内置 markdown 支持,但是没有快捷键的支持,毕竟不是专门为 markdown 而生。普通人可能不会使用 vsocde,适合开发人员使用。

vscode 有一点非常好,就是默认自动保存 md 文件后,会格式化 md 文本格式,会自动添加「盘古之白」。

官网:code.visualstudio.com/


在线工具


mdnice

mdnice 不仅可以编写 markdown,还可以转换成可以适用于各个平台的 html 代码。比如微信公众号、知乎、掘金。

官网:mdnice.com/

Cmd Markdown

经典的 markdown 编辑器。支持在线编辑,也支持客户端下载,客户端和 typora 一样,支持 windows、mac OS、linux。

官网:www.zybuluo.com/mdeditor


语法


标题符号 (#标题)


支持 6 种不同大小的标题,从大到小用 # 的数量表示。

# 号越多,表示标题越小。

# 号与后面的文字之间要有一个空格符号,否则就不会认为这是标题。

# 号必须在行首,才会被认为是标题。

示例:


# 1 级标题
## 2 级标题
...
###### 6 级标题

错误示例:


1 级标题 ## 2 级标题

这里的 # 号就不会认为是标题,而会被认为是普通字符。


强调符号 (**强调文字**)


强调符号就是让字体加粗。

在文字两侧各添加两个 * 号。

示例:


**加粗字体**

效果:

加粗自体


斜体符号 (_斜体文字_ | *斜体文字*)


强调符号就是让字体倾斜。

在文字两侧各添加两个 _ 号或 * 号,两种符号作用是完全相同的,但我更习惯使用_,因为可以更好的和强调符号区分。

示例:


_倾斜字体_

效果如下:

倾斜字体


删除符号 (~~text~~)


删除符号就是让字体添加一道删除线。


~~删除~~

效果:

删除


组合


多种符号可以相互组合。

写法就是将多种符号都添加到文字的两侧,顺序没有影响。

示例:


~~**_多种效果_**~~
_~~**多种效果**~~_

效果:

多种效果


超链接符号 ([描述](超链接地址))


超链接符号可以设置一段文字可以跳转到某个网址。

前面的[]中可以写网站描述。

示例:


[百度](http://www.baidu.com)

效果:

百度


图片符号 (![描述](图片地址))


图片符号可以加载图片资源。

前面的[]中可以写图片描述。

示例:


![百度logo](https://p1-jj.byteimg.com/tos-cn-i-t2oaga2asx/gold-user-assets/2020/5/17/17223141d88c343c~tplv-t2oaga2asx-image.image)

效果:


有序列表 (序号. 文字)


使用数字作为序号. 就可以创建列表。

序号. 后面要有一个空格。

示例:


1. 橘子
2. 苹果
3. 香蕉

效果:

  1. 橘子
  2. 苹果
  3. 香蕉


无序列表 (-. 文字)


使用加号(+)、减号(-)或星号(*)都可以创建列表。推荐使用减号(-)。

减号(-)后面要有一个空格。

示例:


- 橘子
* 苹果
- 香蕉

效果:

  • 橘子
  • 苹果
  • 香蕉


待办列表(TODO List) (- [ ] 文字)


使用- [ ]作为列表项。

中横线(-)和方括号([])之间要有 1 个空格。

方括号([])中间要有 1 个空格或者小写的 x。空格表示未完成,小写的 x 代表已完成。

示例:


- [x] 读书。
- [ ] 健身。

效果:

  • 读书。
  • 健身。


引用 (> 文字)


在需要引用的文字前面添加大于号(>)和 1 个空格。

示例:


> 知乎-有问题,上知乎。知乎,可信赖的问答社区,以让每个人高效获得可信赖的解答为使命。知乎凭借认真、专业和友善的社区氛围,结构化、易获得的优质内容,基于问答的内容生产方式和独特的社区机制,吸引、聚集了各行各业中大量的亲历者、内行人、领域专家、领域爱好者,将高质量的内容透过人的节点来成规模地生产和分享。用户通过问答等交流方式建立信任和连接,打造和提升个人影响力,并发现、获得新机会。

效果:

知乎-有问题,上知乎。知乎,可信赖的问答社区,以让每个人高效获得可信赖的解答为使命。知乎凭借认真、专业和友善的社区氛围,结构化、易获得的优质内容,基于问答的内容生产方式和独特的社区机制,吸引、聚集了各行各业中大量的亲历者、内行人、领域专家、领域爱好者,将高质量的内容透过人的节点来成规模地生产和分享。用户通过问答等交流方式建立信任和连接,打造和提升个人影响力,并发现、获得新机会。


分割线 (___|---|***)


使用三个连续的下划线(_)、中横线(-)或星号(*)都可以创建分割线。但不可以混用。推荐使用 3 个中横线(-)。

示例:


___
---
***

效果:


行内代码 (`代码`)


使用反单引号(`)包裹住代码。

示例:


Talk is cheap. Show me the `code`

效果:

Talk is cheap. Show me the code


代码块 (``` 代码 ```)


使用 3 个连续的反单引号(`)包裹住代码块。

3 个连续的反单引号(`)都要单独占用 1 行。

可以在前面的反单引号(`)后添加对应的编成语言,以便支持代码高亮。

示例:


\`\`\`html
<html>
  <body>
    <h1>hello,world</h1>
  <body>
<html>
\`\`\`
反斜杠(\)是反义符

效果:


<html>
  <body>
    <h1>hello,world</h1>
  </body>
</html>


表格 (| -)


表格使用 竖线(|) 来区分列,用中横线( -)来区分表头和内容。

使用冒号(:) 来表示该列的对齐方式。

示例:


| 姓名 | 性别 | 职业 |
| :----- | :------: | -----: |
| 李小龙 | 男 | 武术家 |
| 泰森 | 男 | 拳击手 |

效果:

姓名 性别 职业
李小龙 武术家
泰森 拳击手



相关文章
|
uml
Markdown总结
Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。 Markdown 语言在 2004 由约翰·格鲁伯(英语:John Gruber)创建。 Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。 Markdown 编写的文档后缀为 .md, .markdown。 Markdown 能被使用来撰写电子书,如:Gitbook。
110 0
【Markdown】初使用
【Markdown】初使用
124 0
|
JavaScript Linux 对象存储
MarkDown常见小技巧
MarkDown常见小技巧
157 0
【Markdown】Markdown的安装与配置
【Markdown】Markdown的安装与配置
608 0
【Markdown】Markdown的安装与配置
|
JavaScript 前端开发
有的时候我觉得我不会 Markdown
「这是我参与2022首次更文挑战的第6天,活动详情查看:2022首次更文挑战」。
148 0
有的时候我觉得我不会 Markdown
你还不会使用 Markdown?
Markdown 是一种轻量级标记语言,创始人为约翰·格鲁伯(John Gruber)。 它允许人们使用易读易写的纯文本格式编写文档,然后转换成有效的 XHTML(或者HTML) 文档。这种语言吸收了很多在电子邮件中已有的纯文本标记的特性,由于 Markdown 的轻量化、易读、易写特性,并且对于图片,图表、数学式都有支持,许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。
你还不会使用 Markdown?
Markdown学习笔记
字体 hello world! hello world! hello world! 两个**为加粗,一个为斜体,三个为斜体加粗 两个~~为删除线效果 引用 引用为‘>’符号 选择java 分割线 三个‘-’或三个‘*’
Markdown学习笔记
MarkDown入门MarkDown介绍
MarkDown入门MarkDown介绍
190 0