markdown教程
2022/5/6大约 3 分钟约 930 字
Markdown 是一种用于编写结构化文档的纯文本格式,基于表示电子邮件和 usenet 帖子格式的约定。它由 John Gruber 开发(在 Aaron Swartz 的帮助下),并于 2004 年以语法描述和 Perl 脚本(Markdown.pl)的形式发布。用于将 Markdown 转换为 HTML。在接下来的十年中,许多语言都发展出了许多实现。有些人使用脚注,表格和其他文档元素的约定扩展了原始 Markdown 语法。有些人允许 Markdown 文档以 HTML 以外的格式呈现。像 Reddit,StackOverflow 和 GitHub 这样的网站有数百万人在使用 Markdown。 Markdown 开始在网络之外使用,编写书籍,文章,幻灯片,信件和讲义。
markdown标准:
基础语法格式
| 排版 | 格式 | 说明 |
|---|---|---|
| 标题 | # 一级标题 ## 二级标题 ### 三级标题 #### 四级标题 ##### 五级标题 ###### 六级标题 也可以是 一级标题 ========= 二级标题 -------- | =====和#是一样的效果 --------和##是一样的效果 |
| 粗体和斜体 | 粗体:两个 * 或两个 _ 包裹(建议使用 * )斜体:一个 * 或一个 _ 包裹(建议使用 * ) | |
| 段落与换行 | 1.如果行与行之间没有空行,则会被视为同一段落 2. 如果行与行之间有空行,则会被视为不同的段落 3.空行是指行内什么都没有,或者只有空格和制表符 4.如果想在段内换行,则需要再上一行的结尾插入两个以上的空格然后按回车键 5.按shift+enter键可强制换行 | |
| 列表 | 有序列表:用数字序号 + 英文句号 + 空格 + 列表内容来标记 无序列表: */+/- + 空格 + 列表内容来标记(推荐用 - ) | |
| 分隔线 | 分隔线由 3 个或 3 个以上的 */-/_ 来标记 | |
| 图片 |  | |
| 链接 | [链接文字](链接地址) | |
| 行内代码 | 行内代码引用使用 ``包裹 | |
| 代码块 | 代码块使用int i | |
| 转义 | 使用 \ 进行转义 |
GFM扩展语法
| 排版 | 格式 | 说明 |
|---|---|---|
| 删除线 | 两个~~包裹 | |
| 表格 | | 表头1 | 表头2 | 表头3 | | ---- | ---- | ---- | | 内容1 | 内容2 | 内容3 | | 内容1 | 内容2 | 内容3 | 1.单元格使用 ` | 来分隔,为了阅读更清晰,建议最前和最后都使用 |
| 任务列表 | 1.任务列表以 - + 空格开头,由[ + 空格 / x + ]组成 2.x 可以小写也可以大写,有些编辑器可能不支持大写,所以推荐使用小写的 x 3. | |
| 锚点 | [锚点描述](#锚点名) |
使用技巧
1.在新标签页打开链接
markdown最后会被输出为html,因此可以使用a标签,然后设置target属性为"_blank"
<a href="xxx.jpg" target="_blank">在新页面打开图形文件</a>
2.嵌入svg文件
嵌入svg文件可以使用embed,object,iframe标签
<object data="xxx.svg" type="image/svg+xml" style="width: 100%;height: 100%;"/>
3.格式转化
Markdown与其他格式的转换使用pandoc
