保持GH主页与README.md同步

时间:2014-03-17 08:18:25

标签: github github-pages

在为我的项目创建GitHub页面时,我建议导入现有的README.md作为项目的主页。之后,我将gh-pagesmaster合并,最后同时使用index.htmlREADME.md

“问题”是README.md的更新不会影响index.html。有没有简单的方法让它们保持同步?最好是零杰基尔知识......

1 个答案:

答案 0 :(得分:2)

这是我想出的,以防有人感兴趣。

通常我使用Jade预处理器编写HTML,幸运的是它支持GitHub Flavored Markdown,这是编写的语言README.md。所以我的步骤如下:

  1. 将GH Pages生成的index.html翻译为Jade。我使用了在线html2jade工具;
  2. 将输出保存到index.jade;
  3. section中生成的标记中找到index.jade块,并将其全部内容替换为:

    section include:md README.md

  4. 运行jade index.jade,生成新的,自动生成的index.html;
  5. 将两个文件都提交到gh-pages
  6. 请参阅GitHub上的this提交中的示例。