如何从GitHub维基页面生成网站

时间:2013-05-25 20:25:40

标签: github documentation wiki documentation-generation github-pages

我已经使用GitHub页面为我的项目生成一个漂亮的网站(this one)。现在我想保持我的项目文档是最新的,并且在一个README.md文件中包含所有内容可能无法扩展到我们添加的许多功能。

所以,我认为保存文档的最佳位置是GitHub wiki,但我想将wiki集成到gh-pages生成的站点,保持漂亮的布局。

我如何使用GitHub wiki并生成具有可自定义布局的HTML网站?

2 个答案:

答案 0 :(得分:7)

以下是wiki的示例网址:

http://github.com/antirez/redis/wiki

在同一页面上,您会找到克隆链接:

git clone http://github.com/antirez/redis.wiki

然后通过Jekyll运行Markdown文件,甚至根据Wiki为主机站点创建一个新的存储库。

答案 1 :(得分:1)

您可以将自己的wiki包含为subtree

BTW,GitHub页面现在不再需要gh-pages分支。创建一个名为your-user-name.github.io的存储库;它会自动生成一个网站。有关详细信息,请参阅GitHub Pages