一个名为Wiki的独立文档系统内置于每个GitLab项目中。它默认在所有新项目上启用,您可以在项目的Wiki下找到它。
如果您不想将文档保存在存储库中,则Wiki非常方便,但您确实会希望将其保存在代码所在的同一项目中。
您可以在Web界面中创建Wiki页面,或使用Git在本地创建Wiki页面,因为每个Wiki都是一个单独的Git存储库。
(注意:查看Wiki需要Guest级别的权限,创建和编辑Wiki页面需要Developer级别。)
第一次创建主页
第一次访问Wiki时,将会指示您创建主页。主页必须创建,因为它在查看Wiki时用作登录页面。您只需填写Content部分,然后单击Create Page。您可以随时编辑它,所以请接着往下写一条欢迎信息吧。
创建一个新的wiki页面
单击可在所有Wiki页面中找到的 New page按钮创建新页面。系统将要求您填写GitLab将从中创建页面路径的页面名称。 您可以为新文件指定完整路径,并自动创建任何缺少的目录。
输入页面名称后,就可以填写其内容了。GitLab wiki支持Markdown,RDoc和AsciiDoc。对于基于Markdown的页面,支持所有Markdown功能,对于链接,存在一些特定于wiki的操作行为。
在Web界面中,提交消息(commit message)是可选的,但GitLabWiki基于Git的并且需要提交消息,因此如果您不输入一个消息的话,系统将为您创建一个消息。
准备好后,单击Create Page,将创建新页面。
(在GitLab 11.3中引入。)
从GitLab 11.3开始,通过GitLab界面上传到wiki的任何文件都将存储在wiki Git存储库中,如果您在本地克隆wiki存储库,它将可用。 GitLab 11.3之前的所有上传文件都存储在GitLab中。 如果您希望它们成为wiki的Git存储库的一部分,您将不得不再次上传它们。
编辑wiki页面
要编辑页面,只需单击“编辑”按钮即可。从那以后,您可以更改其内容。 完成后,单击“保存更改”以使更改生效。
删除wiki页面
只有在编辑页面时才能找到“删除”按钮。单击它并确认您要删除该页面。
移动wiki页面
您可以通过在编辑表单中指定Wiki页面标题中的完整路径,将Wiki页面从一个目录移动到另一个目录。
为了将Wiki页面移动到根目录,wiki页面标题必须以斜杠(/)字符开头。
查看所有已创建的Wiki页面的列表
每个维基都有一个侧边栏,可以从中找到创建页面的简短列表。该列表按字母顺序排序。
如果您有许多页面,则并非所有页面都会列在侧栏中。单击Morepages以查看所有页面。
查看Wiki页面的历史记录
wiki页面随时间的变化记录在维基的Git存储库中,您可以通过单击Page history按钮来查看它们。
在历史记录页面中,您可以看到页面的修订版本(Git commit SHA)、作者、提交消息、最近更新时间以及页面标记格式。 要查看页面的先前版本的外观,请单击修订号。
在本地添加和编辑Wiki页面
由于wiki是基于Git存储库的,因此您可以在本地克隆它们并像对待其他所有Git存储库一样对其进行编辑。
在右侧边栏上,单击克隆存储库,然后按照屏幕上的说明进行操作。
1.需要安装Gollum和github-markdown
2.clone wiki仓库
3.运行Gollum并开始本地编辑
自定义侧栏
默认情况下,wiki会呈现一个侧边栏,其中列出了Wiki的所有页面。您也可以提供_sidebar页面来替换此默认侧边栏。提供此自定义侧边栏页面时,将不会呈现默认侧边栏,而是自定义侧边栏。