支持的 HTML 元素
不在 Markdown 语法涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。
目前支持的 HTML 元素有:<kbd> <b> <i> <em> <sup> <sub> <br>
等等 ,如:
使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑
<b>我是使用b标签的加粗字体</b>
使用 Ctrl+Alt+Del 重启电脑
我是使用b标签的加粗字体
转义
Markdown 使用了很多特殊符号来表示特定的意义,如果需要显示特定的符号则需要使用反斜杠转义字符:
**未转义星号显示加粗**
\*\* 转义显示星号 \*\*
未转义星号显示加粗
** 转义显示星号 **
Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:
\ 反斜线
` 反引号
* 星号
_ 下划线
{} 花括号
[] 方括号
() 小括号
# 井字号
+ 加号
- 减号
. 英文句点
! 感叹号
设置目录
设置之后会根据分级标题来自动生成目录。
[TOC]
注:很多工具都不支持。
在github生成TOC的方法:https://github.com/ekalinin/github-markdown-toc
windows系统需要基于golang实现的工具:https://github.com/ekalinin/github-markdown-toc.go
如果你有GO语言的编译环境,可以尝试自己编译,如果没有,可以直接下载编译好的二进制文件。
如windows系统64位 下载:gh-md-toc.windows.amd64.tgz (386 是32位,amd64是64位)
下载解压后,发现没有后缀名无法识别,实际上这是个exe文件,所以只需要暴力地在后面加上.exe就可以开始愉快使用了。
使用方法:
- 首先将.md文档复制到gh-md-toc.exe的根目录下
- 在该目录下打开系统命令行,输入命令:gh-md-toc.exe README.MD 生成目录
- 把生成的目录复制到.md文件即可。