markdown使用笔记

最新推荐文章于 2022-04-26 16:54:04 发布

ZhangDanzhu

最新推荐文章于 2022-04-26 16:54:04 发布

阅读量593

点赞数

分类专栏： how-to-use 文章标签： markdown 使用学习笔记

本文链接：https://blog.csdn.net/ZhangDanzhu/article/details/69439887

版权

how-to-use 专栏收录该内容

14 篇文章 0 订阅

订阅专栏

markdown学习笔记

兼容HTML

HTML 区块元素――如 <div>、<table>、<pre>、<p> 等标签
- 必须在前后加上空行与其它内容区隔开，还要求它们的开始标签与结尾标签不能用制表符或空格来缩进
- 在 HTML 区块标签间的 Markdown 格式语法将不会被处理
HTML 的区段（行内）标签 —— 如 <span>、<cite>、<del>
- 可以在 Markdown 的段落、列表或是标题里随意使用
- Markdown 语法在 HTML 区段标签间是有效的

特殊字符转换

如果使用的字符是 HTML 字符实体的一部分，markdown会保留原状，否则它会被转换成&xxx;形式

区块元素

段落和换行

一个Markdown段落是由一个或多个连续的文本行组成,它的前后要有一个以上的空行
普通段落不该用空格或制表符来缩进

标题

类 Setext 形式
- 采用底线形式
- 最高阶标题（=）、第二阶标题（-）
类 Atx 形式
- 行首插入 1 到 6 个 # ，对应到标题 1 到 6 阶
- 可以选择性地「闭合」类 atx 样式的标题，这纯粹只是美观用的

区块引用 Blockquotes

在每行的最前面加上 >
Markdown 也允许你偷懒只在整个段落的第一行最前面加上 >
区块引用可以嵌套（例如：引用内的引用），只要根据层次加上不同数量的 >
注：如果 > 和 >> 嵌套使用的话，从 >> 退到 > 时，必须之间要加一个空格或者 > 作为过渡，否则默认为下一行和上一行是同一级别的引用
引用的区块内也可以使用其他的 Markdown 语法，包括标题、列表、代码区块等

列表

支持有序和无序
- 无序列表使用星号、加号或是减号作为列表标记
- 有序使用数字接着一格英文句点
如果列表项目间用空行分开，在输出 HTML 时 Markdown 就会将项目内容用\

代码区块

缩进 4 个空格或是 1 个制表符就可以建立代码区块
Markdown 会用 \

分割线

一行中只有三个以上的星号、减号、底线(可以在中间插入空格)
个人觉得底线不太好，容易误成二阶标题。中间空格也不能插太多，会变成列表项目

区段元素

链接

行内式
- 用方括号标记链接文字，后面紧跟圆括号括起的网址（网址后可用“”加title,鼠标停留时显示）
- 可使用相对路-径链接到同样主机的文件
参考式
- 在链接文字后再加方括号，其中填入用以辨识链接的标记(不区分大小写)（两个方括号可用空格隔开）
- 在文件任意处定义标记的链接内容 [id]: xxxxxx “title”
- 隐式链接标记：链接文字后加空的方括号，链接标记视为等同于链接文字
自动链接
- 用尖括号括起网址或邮箱

强调

使用或_，一个为斜线，两个为加粗(不能两边都为空格)*

代码

单行：使用`***（若在代码中也要使用`，则使用多个反引号来开启和结束）*
多行：使用“`

图片

与链接类似，在前面加！好像还不能设置大小，还是用\

表格

具体使用方式请看示例。
——:为右对齐。
:——为左对齐。
:——:为居中对齐。
——-为使用默认居中对齐。
示例
| 序号 | 交易名 | 交易说明 | 备注 |
| ——: | :——-: | :——— | —— |
| 1 | prfcfg | 菜单配置 | 可以通过此交易查询到所有交易码和菜单的对应关系 |
| 2 | gentmo | 编译所有交易 | |
| 100000 | sysdba | 数据库表模型汇总 | |

序号	交易名	交易说明	备注
1	prfcfg	菜单配置	可以通过此交易查询到所有交易码和菜单的对应关系
2	gentmo	编译所有交易
100000	sysdba	数据库表模型汇总

github上注意点

不支持回车换行，需在行尾使用两个空格
标题(以及分割线)与列表项目间空行，否则不使用正确格式
[TOC]不能直接使用
支持[这是中文]后面跟(#这是中文)来创建toc，若标题混杂英文，则根据以下原则（不全）在#后写标记名：
- remarkable上
  - 按序提取全部英文字母与数字，并使用小写
  - 所有中文字符，操作符（除“-”）全部忽略
  - 所有“-”(即负号)与“ ”（即空格）全部用一个“-”代替
- github上
  - 每一个空格(除前导与后置空格是全部省略外)都用一个-代替
  - 符号(除’-‘,包括中英文标点符号、运算符号及其他符号但不包括希腊字母等)全部省略
  - 英文全部用小写