Markdown语法介绍(详细)
一、什么是 Markdown
Markdown 是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。
二、下载和使用
-
客户端
我使用的是 作业部落 出品的 Cmd Markdown,下面演示也是使用该 IDE 作为演示。
-
网页插件
如果你使用的是 chrome 游览器,那么可以安装一款叫做 Markdown Here 的插件,也是十分好用。
三、应用
用来写博客、邮件
Markdown 很容易转化成 HTML 或者 PDF
git 的 README.md 就是 Markdown 格式的
例如:https://gitee.com/afei_/MarkdownDemo 和 https://github.com/afei-cn/MarkdownDemo
四、语法介绍
注意:很多需要效果展示的地方,参考配图中的红色区域。
- 标题
第一种是使用 # 表示标题,其中 # 号必须在行首,
第二种是使用 === 或者 --- 表示。
- 分割线
使用三个或以上的 - 或者 * 表示,且这一行只有符号,注意不要被识别为二级标题即可,例如中间或者前面可以加空格。
- 斜体和粗体
使用 * 和 ** 分别表示斜体和粗体,删除线使用两个 ~ 表示
- 超链接和图片
链接和图片的写法类似,图片仅在超链接前多了一个 ! ,一般是 [文字描述] (链接)
- 无序列表
使用 -、+ 和 * 表示无序列表,前后留一行空白,可嵌套,例如
- 有序列表
使用 1. (点号后面有个空格)表示有序列表,可嵌套。
- 文字引用
使用 > 表示,可以有多个 >,表示层级更深,例如
- 行内代码块
其实上面已经用过很多次了,即使用 ` 表示,例如
扩展:很多字符是需要转义,使用反斜杠 \ 进行转义
- 代码块
使用四个空格缩进表示代码块,一些 IDE 支持行数提示和着色,一般使用三个 ` 表示,例如
- 表格
直接看例子吧,第二行的 ---: 表示了对齐方式,默认左对齐,还有 右对齐 和 居中
商品 | 数量 | 单价 |
---|---|---|
苹果 | 10 | $1 |
电脑 | 1 | $1000 |
- 流程图
主要的语法为 name=>type: describe,其中 type 主要有以下几种:
1.开始和结束:start end
2.输入输出:inputoutput
3.操作:operation
4.条件:condition
5.子程序:subroutine
更多语法参考:流程图语法参考
- 数学公式
使用 表示在行内,两个 $ 表示独占一行。
eg :
支持 LaTeX 编辑显示支持,访问 MathJax 参考更多使用方法。
推荐一个常用的数学公式在线编译网站:https://private.codecogs.com/latex/eqneditor.php
13.支持 HTML 标签
例如想要段落的缩进,可以如下:
不断行的空白格 或
半方大的空白 或
全方大的空白 或
点我跳转的功能这里演示不了,写法如下:
<h6 id='anchor'>我是一个锚点</h6>
[点我跳转](#anchor)
五、其它
markdown 各个 IDE 的使用可能存在大同小异,一般可以参考各个 IDE 的介绍文档
本文档介绍的内容基本适用于大部分的 IDE