github - 保持 GH 主页与 README.md 同步

标签 github github-pages

在为我的项目创建 GitHub Pages 时,建议我导入现有的 README.md 作为项目的主页。后来,我将 gh-pagesmaster 合并,最终得到了 index.htmlREADME.md

“问题”是 README.md 的更新不会影响 index.html。有什么简单的方法可以让它们保持同步吗?最好是零 Jekyll 知识...

最佳答案

如果有人感兴趣,这就是我的想法。

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

  1. 将 GH Pages 生成的 index.html 转换为 Jade。我网上用过html2jade工具;
  2. 将输出保存到index.jade
  3. index.jade 中的结果标记中找到 section block ,并将其整个内容替换为:

    部分 包括:md README.md

  4. 运行jade index.jade,它会生成新的、自动生成的index.html
  5. 将两个文件提交到 gh-pages

参见 this 中的示例在 GitHub 上提交。

关于github - 保持 GH 主页与 README.md 同步,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/22449520/

相关文章:

带有 : Fetching latest commit… 的 github web 存储库 block

推送分支时的 Github pull 请求链接

github - Github Wiki 和自述文件之间的主要功能区别是什么,

github - 如何将 Aurelia 部署到 GitHub Pages (gh-pages)

css - 我在 jekyll 和 github 页面中错过了什么来使语法高亮工作?

github - 由于 YAML 错误,Hugo 无法使用 GitHub Pages 构建

ios - OAuthSwift和Github-我应该使用哪个授权回调URL?

url - GitHub源码动态导航

Android Studio 不保存 github 访问 token

javascript - 公共(public) Github 页面站点上的 Github API 速率限制