美文网首页Markdown
gitlab上markdown(wiki)的使用--锚点

gitlab上markdown(wiki)的使用--锚点

作者: 小宫同学_ | 来源:发表于2019-12-07 11:29 被阅读0次

前言

最近想使用一下gitlab的wiki来整理公司的技术文档, 在使用过程中想为文章添加一个目录, 首先想到的自然是添加锚点,(这个在我之前的文章markdown的锚点中说过了, 这里不再赘述), 试了一下果然可以, 但是有几个问题需要注意, 特整理在此, 以供查阅.

正文

  1. 在gitlab的wiki中使用标题锚点, 标题中如果有序号(比如1. 前言), 必须要有空格.
  2. 如果标题中使用序号, 在建立锚点时需要用1-代替1., 下面举例说明.

比如我们创建了一个标题

1. 概述

现在想要给它创建一个目录

目录

1. 概述
在gitlab的markdown语法中, 我们应该这样添加

[1. 概述](#1-概述)

可以看到, 我们用1-代替了标题中的1., 因为在gitlab中, 用1.的话是无法跳转的(简书也无法跳转哈, 没仔细研究), 但是在gitlab中用1-的话可以跳转, 但是还有一个条件, 就是标题'1. 概述'中'1.'的后面要加空格, 当然也可以不要'.', 但是要有空格.
ps:
我们在加标题的时候也可以顺便给每个标题都加个目录的锚点, 这样我们在阅读的时候可以很方便的从标题跳转到目录, 像这样:

## [1. 概述](#目录)
## [2. 第一章](#目录)

总结

在gitlab中用markdown写文档, 如果你要用锚点来添加目录的话, 那么有一下几点建议送给你:

  1. 标题尽量不要带序号, 因为上面的方法在gitlab上适用, 但是如果你把文档导出来, 用其他阅读器看的时候, 目录可能就失效了, 所以建议直接用纯文字.
  2. gitlab中的锚点是支持中文的, 也支持中英文混写, 但是如果加序号的话都要有空格.

最后

以上都是我亲自实践得到的结论, 验证无误, 如果对你有所帮助的话, 还请给点个赞哦.

相关文章

  • gitlab上markdown(wiki)的使用--锚点

    前言 最近想使用一下gitlab的wiki来整理公司的技术文档, 在使用过程中想为文章添加一个目录, 首先想到的自...

  • wiki锚的使用

    使用步骤 步骤1:创建一个锚点(即链接的目的地) 步骤2:链接的起始点插入超链接,链接为:#锚点名称保存即可。

  • markdown的锚点

    前言 今天写文章,想要实现文章内的跳转,于是就上网搜索了一番,才了解到锚点这个概念。 锚点是网页制作中的一种,又叫...

  • Confluence 6.15 锚点(Anchor)宏

    允许你链接到页面的特定部分。有关如何使用锚点的内容,请参考页面Anchors页面中的详细内容。 Wiki 标记(m...

  • markdown

    锚点的使用 由于markdown暂时不支持自定义id和name属性,所以 只能借助html标签来定义 使用方法: ...

  • GitLab

    简介 GitLab是由GitLab Inc.开发,使用MIT许可证的基于网络的Git仓库管理工具,且具有wiki和...

  • 随笔(二)

    知识点的整理 基础知识 moodle系統使用的Wiki语法 有道云笔记使用的Markdown语法 搜索引擎的方式技...

  • MacDown语法

    本页跳转 先定义一个锚(id) Hello World 然后使用markdown的语法:...

  • Markdown 语法介绍

    Markdown 语法介绍 目录 [TOC]简书不支持,可用锚点实现 标题 锚点 点击跳转 引用 列表 列表项目标...

  • markdown wiki

    http://itmyhome.com/markdown/index.htmlhttps://github.com...

网友评论

    本文标题:gitlab上markdown(wiki)的使用--锚点

    本文链接:https://www.haomeiwen.com/subject/zkxugctx.html