如何将存储库文件夹用作wiki内容 [英] How to use repository folder as wiki content

问题描述

我在github上有一个公共仓库。其中一个子文件夹包含一个html网站。

我可以使用根html页面作为存储库维基的根目录吗？如果是这样，怎么做？

最好是，我想将wiki指向html文件夹，而不必创建文件夹的副本并将其放入一些'special'文件夹。

解决方案

您可以将wiki存储在gitHub仓库中：

  https://github.com/user/yourProject.wiki.git 
  

它将通过 https://github.com/user/yourProject 获得

如果你想在 yourProject 回购中看到它，你可以引用它作为 submodule 。

但是在任何例如，您不会存储html，如让GitHub更开放：Git支持的Wiki 。您可以使用Markdown语法存储文本页面（也包含相关链接！）。

I have a public repository on github. one of the subfolders contains an html site.

Can i use the root html page as the root of the repository wiki? And if so, how?

Preferably, i'd like to point the wiki to the html folder rather than having to create a copy of the folder and put it in some 'special' folder.

解决方案

You can store your wiki in the gitHub repo:

https://github.com/user/yourProject.wiki.git

It will got with https://github.com/user/yourProject

If you want to see it right in yourProject repo, you could reference it as a submodule.

But in any case, you wouldn't store html, as describe in "Making GitHub More Open: Git-backed Wikis". You would store text page in Markdown syntax (with relative links too!).

这篇关于如何将存储库文件夹用作wiki内容的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！