- 我“拉”了我项目的 wiki 存储库。
- 创建“_sidebar.md”文件。
- git添加
- Git 提交
- 将更改推送到 GitLab。
- 以谷歌浏览器的隐身模式加载我项目的 Wiki 页面。
- 不呈现自定义侧边栏。
我刷新了很多次。没运气。
这是我的 _sidebar.md 的内容:
0. [Home](home)
1. [Page 1](page-1)
2. [Page 2](page-2)
有任何想法吗?
我刷新了很多次。没运气。
这是我的 _sidebar.md 的内容:
0. [Home](home)
1. [Page 1](page-1)
2. [Page 2](page-2)
有任何想法吗?
正如 VonC 解释的那样,它现在可以工作了。但是,您不需要克隆您的存储库。
只需在 GitLab GUI 上创建一个名为_sidebar
. 您可以通过
your-repository/wikis/_sidebar
或在侧边栏中创建编辑链接来访问它:
0. [Home](home)
1. [Page 1](page-1)
2. [Page 2](page-2)
[Edit sidebar](/_sidebar/edit)
现在应该可以使用 GitLab 11.2(2018 年 8 月 22 日),感谢jsooter。
请参阅“自定义 Wiki 侧边栏”:
在 GitLab 项目中使用 Wiki 来扩展文档时,默认情况下,右侧边栏会显示 Wiki 页面结构的分层目录。
但是,在某些情况下,您可能想要提供额外的内容,扩展这组自动列出的页面。
在 GitLab 11.2 中,我们引入了一个选项来通过您自己的自定义侧边栏覆盖生成的目录。 通过添加
_sidebar
Wiki 页面,维护者可以完全自由地定义基于GitLab Flavored Markdown的单个 Wiki 侧边栏。
您还可以使用编辑器确保侧边栏正确无误:请参阅GitLab 13.8(2021 年 1 月)。
快速编辑 Wiki 的侧边栏
创建
_sidebar
在 Wiki 中命名的 Markdown 文件将使用该文件的内容为您的项目生成自定义侧边栏导航菜单。
但是,编辑此文件很棘手,因为界面中无处可_sidebar
再次打开。感谢 GitLab 用户Frank Li的出色社区贡献,从 GitLab 13.8 开始,现在在 Wiki 页面的右上角有一个编辑侧边栏按钮。
_sidebar
如果文件尚不存在,单击此按钮将自动创建文件并在页面编辑器中打开它。
通过这种快速访问,可以更直观地创建和更轻松地维护您的自定义 Wiki 导航。
我发现手动更新侧边栏或目录令人沮丧。所以我写了一个简单的代码,它以正确的格式打印出一个列表,这样你就不需要手动编写它了:
import os
ignore_list = [".git", ".idea", "create_table_of_content.py"]
spaces = " "
def get_all_files_and_directories(path, depth):
spaces_tmp = spaces*depth
file_list = os.listdir(path)
for f in file_list:
if f in ignore_list:
continue
if os.path.isdir(path+"/"+f):
print(f'{spaces_tmp}- {f}')
get_all_files_and_directories(path+"/"+f, depth+1)
elif f.split(".")[-1] == "md":
print(f'{spaces_tmp}- [{f.split(".")[0]}]({f})')
return
if __name__ == '__main__':
c = os.getcwd()
get_all_files_and_directories(c, 0)
只需在 wiki repo 的根目录下运行它。
样本输出:
- The-Code is a directory
- editor-applications is a directory
- [edit_hosts_file](edit_hosts_file.ps1.md)
- [mount_logs_dir](mount_logs_dir.ps1.md)
- [main-editor-app](main-editor-app.ps1.md)
- [setup_tasks](setup_tasks.ps1.md)
- [home](home.md)
- [Logging](Logging.md)
- Execution is a directory
- [User-Data](User-Data.md)
- [General](General.md)
- [File-Structure](File-Structure.md)
- [Running-Manually](Running-Manually.md)
- [About](About.md)
这应该更容易维护。
我发现这个 repo https://github.com/ekalinin/github-markdown-toc有一个按标题创建 TOC 的工具。就我个人而言,我认为使用 TOC 创建单页比创建多页 wiki 更好。