github - 告诉 Jekyll(在 github 页面上)将 README.md 转换为 README.html，而不是 index.html

Question

我正在使用 Jekyll 在 Github Pages 上构建一个项目网页，使用“Dinky”主题，开箱即用。
README.md自动转换为 index.html ，这对于快速入门非常有帮助。

但是，我想有一个单独编写的主页index.md ，而是转换 README.md至 README.html (就像大多数 *.md 文件一样)。当我添加我的 index.md , Jekyll 将其转换为 index.html正如所希望的那样，但现在完全没有转换 README.md — 大概有 index.html作为两者的目标 README.md和 index.md ，后者获胜。

我如何告诉 Jekyll 重新使用 README.html作为 README.md 的转换目标?

最好，我想要一个不需要在 README.md 中添加配置数据的解决方案本身 ，这样我才能继续保持README.md与 master 中的人类可读版本同步分支。

复制它的注意事项:所有这些都发生在通过 Github Pages 在线构建时，以及使用本地 jekyll build 构建时。 .我使用的唯一自定义 jekyll 设置是 gem 'github-pages', group: :jekyll_plugins在网站的 Gemfile , 和 theme: jekyll-theme-dinky在网站的 _config.yml .

它似乎特定于 Github Pages 主题，而不是 Dinky 主题:除 Dinky 之外的其他主题表现出相同的行为，但裸露的 Jekyll 站点似乎没有。

编辑:感谢@wasthishelpful 提供非常有用的评论和部分答案。将 YAML frontmatter 块添加到 README.md设置 permalink: README.html做我想要的。不幸的是，我仍然没有找到仅通过修改 _config.yml 就可以达到相同效果的方法。 :例如在那里添加一个frontmatter默认值

defaults:
  - 
    scope:
      path: "README.md"
    values:
      permalink: "README.html"

似乎没有任何效果。 (我已经尝试过在文件名周围加引号和不加引号，以及在 theme: jekyll-theme-dinky 行之前和之后。)

Answer 1

您可以使用 permalink在 README.md :

---
permalink: README.html
---

TypeTheory: the mathematical study of type theories, in univalent foundations
==========

Code  on C-systems, D-systems, ...

您也可以使用 front matter defaults在您的 _config.yml :

defaults:
  - 
    scope:
      path: "README.md"
    values:
      permalink: "README.html"

但是您仍然需要在 README.md 中处理前台问题让它被 jekyll 解析(即使它是一个空的):

---
---

TypeTheory: the mathematical study of type theories, in univalent foundations
==========

Code  on C-systems, D-systems, ...