项目文档:创建 wiki 页面,还是在存储库中创建 Markdown 文件?



我应该使用 Github/Gitlab 的 Wiki 功能,还是应该在存储库中创建 Markdown 文件?(还是两者兼而有之?

我选择了 Markdown 文件,因为我不知道 wiki 页面是否可移植,或者如何离线访问它们。此外,我有由其相对路径引用的图像。我不确定 wiki 页面存储在哪里以及如何使用相对路径而不是绝对路径。

wiki 页面降价页面。

GitLab 提出了特定于 Wiki 的 Markdown,例如,[Link to File](file.md)作为指向文件的一种方式,相对于当前页面。

例如,GitHub解释了如何将仓库中的图像添加到wiki页面中,同样在markdown中。

两者都解释了如何访问/克隆/更新您的维基:

  • GitHub 帮助页面:

    git clone https://github.com/YOUR_USERNAME/YOUR_REPOSITORY.wiki.git
    
  • GitLab 问题

    git clone https://source.example.com/group/project.wiki.git
    

最新更新