markdown中锚链接实现目录跳转以及注意事项
写在前面
markdown本身支持 Table Content
文中有等级标题后,仅需要在文中插入:
[toc]
即可开启,本文重在介绍在手动写入锚链接时的注意事项。
例如 希望实现跳转至文章末尾的 附录链接
本身操作频率不高。
当文章有分类,需要快速阅读,通常会先在文首部写一个目录,点击可以跳转。
为文章写目录,特别在文章较长的时候,有助于对内容的整体把握,能提高阅读效率。
以下,将写一个基本的锚目录demo,然后特别说明需要注意的几点。
Table Of Content
Demo
Table Of Contents
Installation Instructions
Usage Instructions
Troubleshooting
Compatibility
Notes and Miscellaneous
Building the Extension Bundles
Next Steps, Credits, Feedback, License
Something you should know
Installation Instructions
blablablabla
Usage Instructions
blablablabla
Troubleshooting
blablablabla
Compatibility
blablablabla
Notes and Miscellaneous
blablablabla
Building the Extension Bundles
blablablabla
Next Steps
blablablabla
Credits
blablablabla
Feedback
blablablabla
用htmla标签实现的锚链接
除了用markdown中的锚定义,我们还可以在需要的时候使用html中的a链接的name属性。实现传统的锚点。
//点击:
<a href="#test">Something you should know</a>
//跳转至:
<a name="test">用htmla标签实现的锚链接</a>
注意:markdown 的锚使用中需要特别注意的几点
语法
目录(Table Of Content)
[链接的value值,任意名称](#*1 anchor-name)
锚
#*n Anchor Name
//可以是一级标题、二级、三级····
1. 命名规则
在目录中:
- 链接的名称anchor-name必须全部是小写的,和锚中的名称不区分大小写匹配
- anchor-name对应的锚的名称中的空格要用
“-”
替换 - anchor-name不能含有
“:”
、“()”
、“.”
、%
、$
等等特殊字符,最好就不要有任何字符 - 目录的部分可以是多种样式,例如斜体,粗体,本身都是等级标题,甚至列表元素都行
在锚中:
(指的是正文的标题)
- 不能含有
“:”
、“()”
、“.”
等字符 - 锚只要是标题就行,他可以是任意等级,还可以是列表元素,例如无序列表。
2. 如果锚需要特殊符号该怎么办?
写url的时候anchor-name 直接跳过全部的特殊字符即可,如下示例:
附录链接
这是一个附录内容!