前言
最近想使用一下gitlab的wiki来整理公司的技术文档, 在使用过程中想为文章添加一个目录, 首先想到的自然是添加锚点,(这个在我之前的文章markdown的锚点中说过了, 这里不再赘述), 试了一下果然可以, 但是有几个问题需要注意, 特整理在此, 以供查阅.
正文
- 在gitlab的wiki中使用标题锚点, 标题中如果有序号(比如1. 前言), 必须要有空格.
- 如果标题中使用序号, 在建立锚点时需要用1-代替1., 下面举例说明.
比如我们创建了一个标题
1. 概述
现在想要给它创建一个目录
目录
1. 概述
在gitlab的markdown语法中, 我们应该这样添加
[1. 概述](#1-概述)
可以看到, 我们用1-代替了标题中的1., 因为在gitlab中, 用1.的话是无法跳转的(简书也无法跳转哈, 没仔细研究), 但是在gitlab中用1-的话可以跳转, 但是还有一个条件, 就是标题'1. 概述'中'1.'的后面要加空格, 当然也可以不要'.', 但是要有空格.
ps:
我们在加标题的时候也可以顺便给每个标题都加个目录的锚点, 这样我们在阅读的时候可以很方便的从标题跳转到目录, 像这样:
## [1. 概述](#目录)
## [2. 第一章](#目录)
总结
在gitlab中用markdown写文档, 如果你要用锚点来添加目录的话, 那么有一下几点建议送给你:
- 标题尽量不要带序号, 因为上面的方法在gitlab上适用, 但是如果你把文档导出来, 用其他阅读器看的时候, 目录可能就失效了, 所以建议直接用纯文字.
- gitlab中的锚点是支持中文的, 也支持中英文混写, 但是如果加序号的话都要有空格.
最后
以上都是我亲自实践得到的结论, 验证无误, 如果对你有所帮助的话, 还请给点个赞哦.
