Markdown的前世今生 + CSDN的Markdown语法和使用大全

最新推荐文章于 2021-11-19 01:08:54 发布

望儿山下小苗圃

最新推荐文章于 2021-11-19 01:08:54 发布

阅读量712

点赞数 2

分类专栏：技术杂谈学习笔记

本文链接：https://blog.csdn.net/leozhangit/article/details/109224226

版权

Markdown 亚伦·斯沃茨 CSDN编辑器博客写作轻量级标记语言

关键词由CSDN通过智能技术生成

技术杂谈同时被 2 个专栏收录

5 篇文章 2 订阅

订阅专栏

学习笔记

5 篇文章 2 订阅

订阅专栏

带你理解Markdown的前世今生 + CSDN的Markdown语法和使用大全

带你理解Markdown的前世今生
附录：CSDN编辑器中的Markdown语法和使用说明

带你理解Markdown的前世今生

1. 码字面临的困境

文字是人类思维的载体，从古至今的人们都在码字，经过了从甲骨、简牍、帛布、纸张、电脑，到互联网的演变，是人类文明发展史的一个缩影。自媒体时代，人们码字的积极性更高了，那就从当前大家码字时面临的困境说起。以前，大部分的人在线下习惯使用 Word 或 Pages 码字，在互联网上写作或发言时使用的是「富文本编辑器」（就是写QQ空间日志的那种编辑器），就像下面这个样子。

2020-10-22-RichTextEditor

由于各个不同软件和网站平台的差异，我们看到的文字排版呈现出纷繁复杂的面貌。我们发现，在码字的时候，排版操作繁琐耗时耗力，且很容易打断自己的思路。还有一个更重要的问题是，在这个沉浸在数字化的碎片文字中，时时需要聚合和分享的时代，网上看到的东西，或自己码的文字，在查看、收藏、整理和转发的时候，各种格式不兼容，需要安装不同的软件查看，格式标准还不一致，经常需要重新排版和整理，十分让人抓狂。

2. 亚伦·斯沃茨的故事

说起Markdown的由来, 就要说一下年少成名的计算机天才亚伦·斯沃茨(Aaron Swartz)，他是信仰网络自由的激进派，他反对美国政府禁止网络盗版法案的，认为这个法案将使公众失去网络自由。2011年7月19日斯沃茨被指控自论文库JSTOR上非法下载了大量学术期刊文章，并免费提供给网民，并面临百万美元罚款和最高35年徒刑。2013年1月11日早晨，亚伦·斯沃茨被发现在公寓中结束了27年的为自由而燃烧的生命。亚伦·斯沃茨参与了网摘格式 RSS、文档格式Markdown、创作共用等的开发、发展。现在的Markdown中，就蕴含着他所追求的信仰。

2020-10-22-AaronSwartz

3. Markdown的特点

Markdown是一种轻量级的标记语言，据说它的语法灵感最大的来源还是纯文本email的格式，完全由标点符号标签组成的纯文本。因此它并不复杂，算下来一共只有十多种，其目的是希望大家使用它撰写，并以纯文本形式原样发布，从而方便阅读、方便创作，并利于各平台无缝分发。其中，Markdown最重要的设计是可读性，也就是说这个语言可以直接在字面上的被阅读，而不用担心格式化指令标记的影响。

Markdown的标记符号都是精心挑选的，很容易上手。每一个符号都尽量做到能望文生义，与写作的习惯一脉相承。如：星号 * 括着一个单词（Markdown 中表示强调）看上去就像强调；Markdown的列表看上去就像列表；Markdown 的引文标记 “>” 一看后面就是引用的文字，就和我们在使用 e-mail 等纯文字进行沟通时的习惯基本一样。熟悉Markdown之后，写作效率能得到极大提升，而且它显然更适合阅读，不仅对于读者，对作者本人来说，也便于头脑清醒地进行持续的协作和修改。它的主要特点：

只需关注内容本身，无需操心样式，思路几乎不受影响，给写作带来极大便利
实时可视化展现，逻辑性更强，对作者和读者都有很大帮助
显示效果统一，协作效率高，无数软件都支持，并且直接用纯文本text方式打开也能浏览和修改
可内联 HTML 语法。Markdown 是一种创作格式，语法集合比较小，只是HTML标签的一小部分。但Markdown也可以直接使用 HTML标签，例如用 HTML 标签替代 Markdown 的链接语法。

4. 用Markdown写博客的好处

由于 Markdown 最终是解析成 HTML 的，它顺理成章地成为了互联网上写作的最好格式之一。现在各个博客网站都支持Markdown。而且采用Markdown来写博客，还能给我们带来很多其他的好处。

可以本地排版，所见所得，并直接上传网站
以前写博客，如果不是自建网站，难免需要用线上工具进行编辑，而且各个网站的线上编辑工具也不尽相同，如果频繁写博客，会觉得非常繁琐
可以将最终版的文章在本地保存备份
因为博客文章需要线上编辑和发布，所以最终版本在本地是没有的，通常只能在线上查阅自己的博文。将线上的文章保存到本地并归纳整理，以备随时查阅是非常麻烦的事情。记得以前某博客网站宣布关闭，其用户对如何将博客导出备份归档都非常的头疼。
可以实现文章内容改的版本控制
要是你会使用 Git、SVN 或者其他版本控制工具来管理你的文档，那么你会发现 Markdown 和版本控制工具完美融合，它必定会成为你码字的首选。你可以轻松的实现文档的归档管理，差异比较和版本控制，就像拥有了时光机一样，随时回退到任何一个时点查看自己之前文档的内容。
多人协作进行文档编写
通过Markdown的轻量型标记语言特性，和版本控制的辅助，你会发现一群同好或团队内部协同编写文档这件事儿，忽然变的很简单。。。
更多好处，待你慢慢发现
你可以直接把你的 Markdown 文件使用 Github Gist 发布，也可以使用 Hexo、docsify 等工具十分高效地转换成自己的个人网站。

5. 参考资料

今天关于Markdown先写到这里。下面是本文引用过的几个参考资料的链接。

简书：为什么你应该用Markdown写作

Markdown：怎么用，以及为什么用

本想就此结束，因为Markdown的语法确实很简单，而且相关的资料也很多，虽然你搜到的学习资料可能会有些良莠不齐。
但是我猜想读到本文后，大家可能会感觉被吊足了胃口，却为啥不让看到其真容呢。于是我找一个最实用的办法，就是把CSDN的Markdown编辑器中对其Markdown语法的说明复制过来，做一下加工，这样也便于不能通过双屏展示的用户进行单屏浏览。如果你想学习如何使用Markdown编辑器写博客, 可以通过下面的部分，了解一下Markdown的基本语法知识。

附录：CSDN编辑器中的Markdown语法和使用说明

1. 编辑器的功能快捷键

撤销：Ctrl/Command + Z

重做：Ctrl/Command + Y

加粗：Ctrl/Command + B

斜体：Ctrl/Command + I

标题：Ctrl/Command + Shift + H

无序列表：Ctrl/Command + Shift + U

有序列表：Ctrl/Command + Shift + O

检查列表：Ctrl/Command + Shift + C

插入代码：Ctrl/Command + Shift + K

插入链接：Ctrl/Command + Shift + L

插入图片：Ctrl/Command + Shift + G

查找：Ctrl/Command + F

替换：Ctrl/Command + G

2. 合理的创建标题，有助于目录的生成

直接输入1次#，并按下space后，将生成1级标题。

输入2次#，并按下space后，将生成2级标题。

以此类推，我们支持6级标题。有助于使用TOC语法后生成一个完美的目录。

3. 如何改变文本的样式

Markdown语法：

*强调文本* _强调文本_
**加粗文本** __加粗文本__
==标记文本==
~~删除文本~~
> 引用文本
H~2~O is是液体。
2^10^ 运算结果是 1024.

渲染效果 :

强调文本 强调文本

加粗文本 加粗文本

标记文本

~~删除文本~~

引用文本

H₂O is是液体。

2¹⁰ 运算结果是 1024.

4. 插入链接与图片

Markdown语法：

链接: [link](https://www.csdn.net/).
图片: ![Alt](https://i-blog.csdnimg.cn/blog_migrate/2c5626d1121945cb84be5bc1cdd2de45.gif)
带尺寸的图片: ![Alt](https://i-blog.csdnimg.cn/blog_migrate/2c5626d1121945cb84be5bc1cdd2de45.gif =30x30)
居中的图片: ![Alt](https://i-blog.csdnimg.cn/blog_migrate/2c5626d1121945cb84be5bc1cdd2de45.gif#pic_center)
居中并且带尺寸的图片: ![Alt](https://i-blog.csdnimg.cn/blog_migrate/2c5626d1121945cb84be5bc1cdd2de45.gif#pic_center =30x30)

渲染效果 :

链接: link.

图片: Alt

带尺寸的图片:

居中的图片: Alt

居中并且带尺寸的图片:

5. 如何插入一段漂亮的代码片

Markdown语法：

    `代码片效果预览`.
    ```javascript
    // An highlighted block
    var foo = 'bar';
    ```

去博客设置页面，选择一款你喜欢的代码片高亮样式，下面展示同样高亮的

渲染效果 :

代码片效果预览.

// An highlighted block
var foo = 'bar';

6. 生成一个适合你的列表

Markdown语法：

- 项目
  - 项目
    - 项目

1. 项目1
2. 项目2
3. 项目3

- [ ] 计划任务
- [x] 完成任务

渲染效果 :

项目
- 项目
  - 项目

项目1
项目2
项目3

计划任务
完成任务

7. 创建表格

一个简单的表格的Markdown语法：

项目     | Value
-------- | -----
电脑  | $1600
手机  | $12
导管  | $1

渲染效果 :

项目	Value
电脑	$1600
手机	$12
导管	$1

设定内容居中、居左、居右，Markdown语法 :

使用`:---------:`居中
使用`:----------`居左
使用`----------:`居右
| 第一列       | 第二列         | 第三列        |
|:-----------:| -------------:|:-------------|
| 第一列文本居中 | 第二列文本居右  | 第三列文本居左 |

渲染效果 :

第一列	第二列	第三列
第一列文本居中	第二列文本居右	第三列文本居左

SmartyPants 的 Markdown语法：

SmartyPants将ASCII标点字符转换为“智能”印刷标点HTML实体。例如：

|    TYPE   |ASCII                          |HTML
|----------------|-------------------------------|-----------------------------|
|Single backticks|`'Isn't this fun?'`            |'Isn't this fun?'            |
|Quotes          |`"Isn't this fun?"`            |"Isn't this fun?"            |
|Dashes          |`-- is en-dash, --- is em-dash`|-- is en-dash, --- is em-dash|

渲染效果 :

TYPE	ASCII	HTML
Single backticks	`'Isn't this fun?'`	‘Isn’t this fun?’
Quotes	`"Isn't this fun?"`	“Isn’t this fun?”
Dashes	`-- is en-dash, --- is em-dash`	– is en-dash, — is em-dash

8. 创建一个自定义列表

Markdown语法：

Markdown
:  Text-to-HTML conversion tool
Authors
:  John
:  Luke

渲染效果 :

Markdown

Text-to- HTML conversion tool

Authors

John

Luke

9. 创建一个注脚

Markdown语法：

一个具有注脚的文本。[^1]
[^1]: 注脚的解释，都会放在本文档的最后（将文档拉倒最下面可以看到）

渲染效果 :

一个具有注脚的文本。¹

10. 注释

Markdown语法：

Markdown将文本转换为 HTML。
*[HTML]:   超文本标记语言

渲染效果 :

Markdown将文本转换为 HTML。

11. KaTeX数学公式

Markdown语法：

您可以使用渲染LaTeX数学表达式 [KaTeX](https://khan.github.io/KaTeX/):
Gamma公式展示 $\Gamma(n) = (n-1)!\quad\forall
n\in\mathbb N$ 是通过欧拉积分
$$
\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.
$$

你可以找到更多关于的信息 LaTeX 数学表达式here.

渲染效果 :

您可以使用渲染LaTeX数学表达式 KaTeX:

Gamma公式展示 $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$ 是通过欧拉积分

$\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.$

12. 甘特图功能(新增)

Markdown语法：

    ```mermaid
    gantt
            dateFormat  YYYY-MM-DD
            title Adding GANTT diagram functionality to mermaid
            section 现有任务
            已完成               :done,    des1, 2014-01-06,2014-01-08
            进行中               :active,  des2, 2014-01-09, 3d
            计划一               :         des3, after des2, 5d
            计划二               :         des4, after des3, 5d
    ```

关于 甘特图 语法，参考这儿,

渲染效果 :

13. UML 图表

Markdown语法：

可以使用UML图表进行渲染。 Mermaid. 例如下面产生的一个序列图：

    ```mermaid
    sequenceDiagram
    张三 ->> 李四: 你好！李四, 最近怎么样?
    李四-->>王五: 你最近怎么样，王五？
    李四--x 张三: 我很好，谢谢!
    李四-x 王五: 我很好，谢谢!
    Note right of 王五: 李四想了很长时间, 文字太长了<br/>不适合放在一行.

    李四-->>张三: 打量着王五...
    张三->>王五: 很好... 王五, 你怎么样?
    ```

这将产生一个流程图。:



    ```mermaid
    graph LR
    A[长方形] -- 链接 --> B((圆))
    A --> C(圆角长方形)
    B --> D{菱形}
    C --> D
    ```

关于 Mermaid 语法，参考这儿,

渲染效果 :

14. FLowchart流程图

支持flowchart的流程图，Markdown语法：

    ```mermaid
    flowchat
    st=>start: 开始
    e=>end: 结束
    op=>operation: 我的操作
    cond=>condition: 确认？

    st->op->cond
    cond(yes)->e
    cond(no)->op
    ```

关于 Flowchart流程图 语法，参考这儿.

渲染效果 :

15. 导出与导入

导出

如果你想尝试使用此编辑器, 你可以在此篇文章任意编辑。当你完成了一篇文章的写作, 在上方工具栏找到 文章导出 ，生成一个.md文件或者.html文件进行本地保存。

导入

如果你想加载一篇你写过的.md文件，在上方工具栏可以选择导入功能进行对应扩展名的文件导入，
继续你的创作。

16. Markdown详细技术资料参考

学会上面这些内容，并熟练运用之后，就完全可以应付在博客平台的写作生涯了。但是如果你想更深入的了解，因为Markdown语法集合比较小，且最终是解析成 HTML 来显示的，如需要对Markdown进行更认真和专业的研究，可以参考如下网站，了解 Markdown语法与 HTML语法的对应和转换关系。

Markdown 语法说明 (简体中文版)

Markdown: Basics （快速入门）

注脚的解释，都会放在本文档的最后。 ↩︎

望儿山下小苗圃

关注

2
点赞
踩
3

收藏

觉得还不错? 一键收藏
0
评论
Markdown的前世今生 + CSDN的Markdown语法和使用大全

带你理解Markdown的前世今生带你理解Markdown的前世今生码字面临的困境亚伦·斯沃茨的故事Markdown的特点用Markdown写博客的好处参考资料附录：CSDN编辑器中的Markdown语法和使用说明1. 编辑器的功能快捷键2. 合理的创建标题，有助于目录的生成3. 如何改变文本的样式Markdown语法：渲染效果 :4. 插入链接与图片Markdown语法：渲染效果 :5. 如何插入一段漂亮的代码片Markdown语法：渲染效果 :6. 生成一个适合你的列表Markdown语法：渲染效果 :
复制链接

扫一扫