在 GitLab 中创建结构化 wiki 页面

问题描述 投票:0回答:1

我正在尝试使用 GitLab Web 界面在 GitLab 上创建一个结构化 wiki 页面。 这是我的主页使用的结构:

# Introduction to the project

<details>
<summary>[Section1](Section1.md)</summary>

- [Subsection1](Section1.md#first)
- [Subsection2](Section1.md#second)
</details>

<details>
<summary>[Section2](Section2.md)</summary>

- [Subsection3](Subsection3.md):
  - [Subsubsection1](Subsection3.md#first)
  - [Subsubsection2](Subsection3.md#second)
  
- [Subsection4](Subsection4.md):
  - [Subsubsection1](Subsection4.md#first)
  - [Subsubsection2](Subsection4.md#second)
  - [Subsubsection3](Subsection4.md#third)

</details>

<details>
<summary>[Section3](Section3.md)</summary>

- [Subsection5](Subsection5.md):
  - [Subsubsection1](Subsection5.md#first)
  - [Subsubsection2](Subsection5.md#second)
  
- [Subsection6](Subsection6.md):
  - [Subsubsection1](Subsection6.md#first)
  - [Subsubsection2](Subsection6.md#second)
  
- [Subsection7](Subsection7.md):
  - [Subsubsection1](Subsection7.md#first)
  - [Subsubsection2](Subsection7.md#second)

</details>


# Conclusion
- Some conclusion
- Some conclusion


您可能知道这一点,我单击

wiki
按钮,然后我只需单击创建一个新页面,这允许我创建我的第一个页面,默认情况下为
home
页面。这给了我类似的东西:

GitLab wiki home page

然后,要创建主页中显示的所有

*.md
文件,我只需单击主页中相关部分的超链接,该链接将打开一个新页面,要求我创建一个新页面,默认情况下,它会填充该页面的名称扩展名为
.md
的文件,如下图所示

creating a new page

因此,当我保存页面时,它会给出以下内容

new markdown file

正如您在页面顶部看到的,我可以看到 Markdown 文件的名称及其扩展名,这是不希望的。所以第一个问题是我应该如何摆脱 markdown 文件的名称并使用

# Title
保留 markdown 文件中提到的标题。

第二个问题是关于右侧栏的,我知道我可以通过单击右上角的齿轮图标来创建一个名为

_sidebar.md
的文件,但是当我这样做时,尽管我可以自定义侧栏默认页面仍然保留在右侧并且没有消失,这正常吗?

顺便说一下,我正在尝试在 GitLab Web 界面上完成所有这些操作。尽管如果您建议解决方案,例如首先在本地完成所有这些,然后将它们推送到 GitLab,那仍然没问题,只需要它能够工作即可。

gitlab markdown gitlab-wiki
1个回答
0
投票

为了消除不需要的细微差别,需要进行一些修改,例如 wiki 页面标题中 Markdown 文件的扩展名。

  • home.md
    中,删除 Markdown 文件名称中的
    .md
    扩展名(例如
    Section1.md
    ),只使用
    .md
    文件的名称,例如
    Section1
    ,这样你就不会在页面顶部看到扩展程序了。
  • 要进行的另一个修改是删除诸如
    #first
    #second
    之类的标签。 GitLab wiki 目前不支持自定义锚点。

所有 Markdown 渲染的标题都会自动获取可链接的 ID,评论除外。

尽管解决此限制的一种方法是使用带有

HTML
属性的
<a>
id
标签。

<a id="custom-label"></a>

将此

<a>
标签放置在您要创建自定义锚点的位置。例如,在标题之后或文本部分内。

要从同一 Markdown 文件的其他部分链接到此自定义锚点,您可以使用

[Link Text](YourMarkdownFile#custom-label)

这可能有效,也可能无效,但您可以尝试。由于 GitLab 不允许用户在 Markdown 中设置 HTML ID 属性,因此它很可能不起作用。

对于侧边栏,有一些解决方法,例如创建

sidebar.yaml
,仅在 GitLab Premium 和 Ultimate 版本中受支持。

© www.soinside.com 2019 - 2024. All rights reserved.