在GitHub Pages Jekyll网站上呈现GitHub wiki

时间:2014-08-30 04:08:29

标签: git github jekyll github-pages

我有一个存储库,其中包含超过80页的wiki。我想在项目的Jekyll(GitHub页面)网站上呈现所有维基页面的索引,以及使用自定义布局渲染网站上的每个页面,并使用网站其余部分的样式。

要做到这一点,我的第一直觉是使用git子模块在Wekyll网站的回购中包含来自wiki(GitHub公开为git repo)的页面。但就我而言:据我所知,Jekyll无处可接受不符合帖子的降价文件。他们没有以约会命名,他们也没有任何先例,所以Jekyll只是忽略了它们。

为了解决这个问题,我通常只会编写一个插件来执行我想要的操作。但由于该网站托管在GitHub页面上,因此它不会允许我创建的任何插件。

所以,我真的不知道如何继续。是否可以没有自定义插件?

1 个答案:

答案 0 :(得分:8)

这个想法是:

  1. 下载我的插件:https://github.com/djacquel/WikiToJekyll
  2. 阅读文档
  3. 安装和rake
  4. 喝啤酒
  5. 我在这里测试了它:https://github.com/djacquel/JekyllTest/tree/gh-pages 使用此Wiki页面:https://github.com/djacquel/JekyllTest/wiki

    一旦安装和配置(5分钟),raketask /插件正在做什么:

    1. rake wikisub添加一个指向您的wiki的git子模块。必须是公共维基,但可以在另一个存储库
    2. 使用yaml front matter复制并转换下载的wiki页面为markdown
    3. 构建Jekyll,然后插件拦截wiki页面链接转换,将它们转换为Jekyll链接
    4. 订购比萨饼
    5. 目前唯一的问题是(或不是)Kramdown与Github降价不太合适。你必须切换到redcarpet。

      还有其他两项任务:

      • rake wikibuild:重建维基页面

      • rake wiki:同步维基页面,构建并可选择将更改推送到Jekyll存储库

      Et hop!

相关问题