常用MD语法说明
强调内容(docsify)
适合显示重要的提示信息,语法为: !> 内容。
!> 一段重要的内容,可以和其他 Markdown 语法混用。
普通提示(docsify)
普通的提示信息,比如写 TODO 或者参考内容等。语法为:?>内容
?> TODO 完善示例
正常引用形式
内容概要信息,语法为: > 提示内容。
这里是普通的内容概要信息
单行代码标记
如果代码量比较少,只有单行的话,可以用单反引号包起来,如下:
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
多行代码标记
大量代码,需要多行使用,用```包裹起来
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>金财运营接口规范</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description" content="Description">
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
</head>
<body>
<div id="app"></div>
<script>
window.$docsify = {
//定义路由别名,可以更自由的定义路由规则。 支持正则。
alias: {
'/.*/_sidebar.md': '/_sidebar.md'
},
// 加载 _sidebar.md,加载自定义侧边栏
loadSidebar: true,
//加载自定义导航栏
loadNavbar: true,
// 强制悬停,切换页面后是否自动跳转到页面顶部。
auto2top: true,
// 调整副标题的级数
subMaxLevel: 2,
// 替换主题色
themeColor: '#4CAF50',
themeable: {
readyTransition : true, // default
responsiveTables: true // default
},
showLevel: true,
//文档标题,会显示在侧边栏顶部。
name: '',
//配置仓库地址或者 username/repo 的字符串,会在页面右上角渲染一个 GitHub Corner 挂件。
repo: '',
//禁用 emoji 解析
noEmoji: true,
tocLevel: 6,
//搜索配置项
search: {
maxAge: 86400000, // 过期时间,单位毫秒,默认一天
paths: 'auto', // or 'auto'
placeholder: '搜索',
noData: '找不到结果',
// 搜索标题的最大程级, 1 - 6
depth: 4
},
pagination: {
previousText: '上一章节',
nextText: '下一章节',
}
}
</script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
<script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
<script src="//unpkg.com/docsify-pagination/dist/docsify-pagination.min.js"></script>
<script src="//unpkg.com/docsify-copy-code"></script>
<script src="//unpkg.com/prismjs/components/prism-sql.min.js"></script>
<script src="//unpkg.com/prismjs/components/prism-http.min.js"></script>
<script src="//unpkg.com/prismjs/components/prism-json.min.js"></script>
<script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
<script src="//unpkg.com/prismjs/components/prism-java.min.js"></script>
<script src="//unpkg.com/prismjs/components/prism-markdown.min.js"></script>
<script src="//unpkg.com/prismjs/components/prism-nginx.min.js"></script>
<script src="//unpkg.com/prismjs/components/prism-php.min.js"></script>
<script src="//unpkg.com/prismjs/components/prism-python.min.js"></script>
<script src="//unpkg.com/docsify-pagination/dist/docsify-pagination.min.js"></script>
<!-- docsify-themeable -->
<script src="https://unpkg.com/docsify-themeable"></script>
</body>
</html>
表格样式
//例子一
|123|234|345|
|:-|:-:|-:|
|abc|bcd|cde|
|abc|bcd|cde|
|abc|bcd|cde|
//例子二
|123|234|345|
|:---|:---:|---:|
|abc|bcd|cde|
|abc|bcd|cde|
|abc|bcd|cde|
//例子三
123|234|345
:-|:-:|-:
abc|bcd|cde
abc|bcd|cde
abc|bcd|cde
例子一
| 123 | 234 | 345 |
|---|---|---|
| abc | bcd | cde |
| abc | bcd | cde |
| abc | bcd | cde |
例子二
| 123 | 234 | 345 |
|---|---|---|
| abc | bcd | cde |
| abc | bcd | cde |
| abc | bcd | cde |
例子三
| 123 | 234 | 345 |
|---|---|---|
| abc | bcd | cde |
| abc | bcd | cde |
| abc | bcd | cde |
上面三个例子的效果一样,由此可得:
- 表格的格式不一定要对的非常起,但是为了良好的变成风格,尽量对齐是最好的
- 分割线后面的冒号表示对齐方式,写在左边表示左对齐,右边为右对齐,两边都写表示居中
标题样式
前面带#号,后面带文字,分别表示h1-h6,只到h6,而且h1下面会有一条横线
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
链接
链接的文字放在[]中,链接地址放在随后的()中,链接也可以带title属性,链接地址后面空一格,然后用引号引起来







网友评论