MarkDown 基本语法

简介

Markdown 是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档。
Markdown 语言在 2004 由约翰·格鲁伯（英语：John Gruber）创建。
Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。
Markdown 编写的文档后缀为 .md, .markdown。

心得

  • 先把心得放最前面，防止放最后没人看到：）。
  • 本地GitBook Editor存放路径：C:\Users\guzicheng\GitBook\Library\Import
  • 查看效果：管理员cmd --> cd openlayers --> git serve
  • 在使用MarkDown时，只要熟记语法，写文档起来比文本编辑器方便很多。但是还是会有很多功能没法实现，首先可以尝试用html标签解决。
  • 在语法标签后与文字中间，我喜欢加一个空格（如：#（空格）我是标题），看起来比较舒服，但是有部分标签需要注意，如*斜体*，中间加空格（*（空格）斜体（空格）*）就会变成列表形式。
  • 本文是从网上搜集的资料加以综合形成，发现有些地方描述不尽相同，推测可能是不同版本或不同编辑器导致的，文本用的是GitBook Editor Version7.0.12
  • GitBook Editor的预览有时候不是实时同步的，view ---> Toggle Preview重新开一下即可。
  • 每写完一行后，尽量用回车，避免上一行有特殊标签影响下一行，回车并不会影响MarkDown换行，MarkDown换行为三个空格。
  • 本文将根据实际遇到情况不定时更新

一、标题

规则

设置为标题的文字前加#（#（空格）文字），支持六级标题

示例
 # 一级标题
 ## 二级标题
 ### 三级标题
 #### 四级标题
 ##### 五级标题
 ###### 六级标题
效果如下

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

二、字体

规则

字体用符号包起来，*与_效果一样，中间尽量不加空格

示例
**这是加粗的文字**
__这是倾斜的文字__
*这是倾斜的文字*
_这是倾斜的文字_
***这是斜体加粗的文字***
___这是斜体加粗的文字___
~~这是加删除线的文字~~
效果如下

这是加粗的文字
这是倾斜的文字
这是倾斜的文字
这是倾斜的文字
这是斜体加粗的文字
这是斜体加粗的文字
这是加删除线的文字

三、引用

规则

在引用的文字前加>即可。引用也可以嵌套，如加两个>>三个>>>

示例
> 引用内容
>> 引用内容
>>> 引用内容
>>>>>>>> 引用内容
效果如下

引用内容

引用内容

引用内容

引用内容

四、分割线

规则

三个以上的-或*，无论打多少个符号，效果是一样的

示例
下面有分割线
---
下面有分割线
------
下面有分割线
***
下面有分割线
******
效果如下
下面有分割线
下面有分割线
下面有分割线
下面有分割线

五、 图片

规则1
![alt属性文本](图片地址)
![alt属性文本](图片地址 "可选标题")
alt属性文本：对图片的解释，图片裂开时显示
图片地址：图片的地址
可选标题：当鼠标移到图片上时显示的内容，可加可不加
示例1
![RUNOOB 图标](https://img2018.cnblogs.com/blog/365445/201911/365445-20191127140421532-627819498.png)
![菜鸟](http://static.runoob.com/images/runoob-logo.png "这里是可选标题")
效果如下1

RUNOOB 图标

菜鸟

规则2

MarkDown不支持控制图片大小，可以用html标签替代

示例2
<img src="http://static.runoob.com/images/runoob-logo.png" width="100%">
效果如下2

六、 超链接

规则
[超链接名](超链接地址 "超链接title")

超链接名：显示的超链接名字
超链接地址：跳转地址
超链接title：鼠标移上显示名称
示例
[简书](http://jianshu.com)
[百度](http://www.baidu.com "百度")
效果如下

简书
百度

七、 列表

无序列表

规则

+或-或*，加空格，加文字，三种标签效果都一样，如：+（空格）列表内容

示例
- 列表内容
* 列表内容
+ 列表内容
效果如下
  • 列表内容
  • 列表内容
  • 列表内容

有序列表

规则

数字加.，加空格，如：1.（空格）列表内容

示例
1. 列表内容
2. 列表内容
3. 列表内容
效果如下
  1. 列表内容
  2. 列表内容
  3. 列表内容

自定义列表

规则

只要在下级节点前，加三个空格即可

示例（顺便测试一下样式）
* 第一章
1. 第一节
2. 第二节
* 第二章
7. 第四节（这里前面的编号会自动默认从1开始，无法更改）
8. 第五节
3. 第三章（这里列表样式会默认跟前面同级节点）
1. 第六节
2. 第七节
3. 第八节（这里前面的编号会自动默认从1开始，无法更改）
2. 第九节
效果如下
  • 第一章
  1. 第一节
  2. 第二节
  • 第二章
  1. 第四节（这里前面的编号会自动默认从1开始，无法更改）
  2. 第五节
  3. 第三章（这里列表样式会默认跟前面同级节点）
  • 第六节
  • 第七节
  1. 第八节（这里前面的编号会自动默认从1开始，无法更改）
  2. 第九节

八、 表格

规则
表头1 | 表头2 | 表头3
:- | :-: | -:
11 | 12 | 13
21 | 22 | 23

用|表示分隔线，分割不同单元格。
用-隔开表头和其他行，还可以表示对齐方式：
文字默认居左
-左边加：（:-）表示文字居左
-两边加：（:-:）表示文字居中
-右边加：（-:）表示文字居右
示例
表头1 | 表头2 | 表头3
:- | :-: | -:
11 | 12 | 13
21 | 22 | 23
效果如下
表头1 表头2 表头3
11 12 13
21 22 23

九、 代码

规则

单行代码：用`将代码包起来，如：代码
多行代码：用```将代码包起来，如：我是代码块

效果如下

单行代码：
Hello World!

代码块：

function sayHi(){
console.log("Hello World");
}

十、 段落

规则

段落没有特殊规则，换行是使用两个以上空格加上回车。

示例

我是段落第一行（空格）（空格）（空格）（回车）
我是段落第二行

效果如下

我是段落第一行
我是段落第二行

十一、脚注

规则
[^要注明的文本]
示例
创建脚注格式类似这样 [^RUNOOB]。   
[^RUNOOB]: 菜鸟教程 -- 学的不仅是技术，更是梦想！！！
效果如下

创建脚注格式类似这样 [1]

十二、HTML

规则
MarkDown支持html标签，如<kbd> <b> <i> <em> <sup> <sub> <br>等
示例
使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑
效果如下

使用 Ctrl+Alt+Del 重启电脑

十三、转义

规则

Markdown 使用了很多特殊符号来表示特定的意义，如果需要显示特定的符号则需要使用转义字符，Markdown 使用反斜杠转义特殊字符

示例
**文本加粗**
\*\* 正常显示星号 \*\*
效果如下

文本加粗
** 正常显示星号 **

更多高级功能

上面列举了很多基本的常用的语法，实际上MarkDown还能做更多，在此先记录，等用到再补充。
参考：菜鸟教程
数学公式
横向流程图
竖向流程图
标准流程图
标准流程图（横向）
UML时序图（简单版）
UML时序图（复杂版）
UML时序图（标准）
甘特图

  1. 菜鸟教程 -- 学的不仅是技术，更是梦想！！！ ↩︎

posted @ 2019-11-27 14:04  苍龙de链  阅读(399)  评论(0)  编辑  收藏  举报