项目文档:创建维基页面,或在仓库中创建Markdown文件?

时间:2017-08-10 03:33:51

标签: git github gitlab

我应该使用Github / Gitlab的Wiki功能,还是应该在回购中创建Markdown文件?(或两者都有?)

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

1 个答案:

答案 0 :(得分:1)

维基页面降价页面。

GitLab建议Wiki-specific Markdown 使用[Link to File](file.md)作为指向文件的方式,相对于当前页面。

例如,GitHub在降价时再次解释了如何add images from your repo into your wiki page

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

  • GitHub help page

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

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