我们按惯例来讲,先讲讲Markdown是什么,然后后面是一个自己练习的教程,不过由于CSND已经帮我们把基本所有的语法都放在了他的“帮助文档”里,基本上我们编辑文档只需要翻到相应的位置就可以得到对应的Markdown实例,但是由于我个人还在其他地方也用到Markdown,所以介绍完以后 还有继续把Markdown的用法简单使用一下。
Markdown简介
Markdown是一种轻量级标记语言,创始人为约翰·格鲁伯(英语:John Gruber)。它允许人们“使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档”。这种语言吸收了很多在电子邮件中已有的纯文本标记的特性。
由于Markdown的轻量化、易读易写特性,并且对于图片,图表、数学式都有支持,当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。例如:GitHub、reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge等。甚至Markdown能被使用来撰写电子书。
CommonMark
从2012年开始,包括Jeff Atwood和John MacFarlane在内的一群人启动了标准化工作。一个社区网站现在旨在“记录可用于文档作者和开发人员的各种工具和资源,以及各种markdown实现的实现者 “。 2014年9月,Gruber反对在这一工作中继续使用”Markdown“这个名字,其被更名为CommonMark 。CommonMark.org发布了规范、参考实现和测试包的几个版本,以及 “[计划]在2018年宣布最终的1.0规范和测试包。
GFM
2017年,GitHub发布了基于CommonMark的GitHub Flavored Markdown(GFM)的正式规范。除了表格、删除线、自动链接和任务列表被GitHub规范作为扩展添加之外,它遵循CommonMark规范。 GitHub还相应地更改了其站点上使用的解析器,这要求更改某些文档 - 例如,GFM现在要求创建标题的哈希符号由空格字符分隔。
Markdown Extra
Markdown Extra是一种轻量级标记语言,基于在PHP(最初)、Python和Ruby中实现的Markdown。它添加了普通Markdown语法不具备的功能。内容管理系统支持Markdown Extra,例如Drupal,TYPO3和MediaWiki。
它为Markdown添加了以下功能:
HTML块内的markdown标记
具有id / class属性的元素
围栏代码块
表格
定义清单
脚注
缩写
以上来自维基百科——Markdown
接下来就是Markdown 的各个指令的使用示例了。
1.标题
Markdown支持六级标题,在排版的时候 用“#”来确定是第几级标题。
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
文本样式
强调文本
加粗文本
标记文本
删除文本
引用文本
列表
- 主列表
- 副列表
- 副副列表
- 副列表
- 项目1
- 项目2
- 项目3
- 计划任务
- 完成任务
连接
图片居中,在网址后面加“#pic_center”
再在后面 加“=像素x像素”就可以使得图片呈居中且改变图片大小
代码片
可以设定是什么语言的代码片
def hello_world():
print('hello world')
hellp_world()
表格
项目 | 价格 |
---|---|
电脑 | 1000¥ |
手机 | 500¥ |
笔 | 30¥ |
LaTex 数学公式
Γ ( n ) = ( n − 1 ) ! ∀ n ∈ N \Gamma(n) = (n-1)!\quad\forall n\in\mathbb N Γ(n)=(n−1)!∀n∈N
Γ ( z ) = ∫ 0 ∞ t z − 1 e − t d t . \Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,. Γ(z)=∫0∞tz−1e−tdt.
插入甘特图
即 在代码框 用的是 mermaid 的文本格式