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的目标{1}}和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前端块添加到README.md设置permalink: README.html可以实现我的目标。不幸的是，我仍然没有找到通过修改_config.yml来达到同样效果的方法：例如在那里添加一个前置默认值

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

似乎没有任何效果。（我在文件名周围有和没有引号，以及行theme: jekyll-theme-dinky之前和之后都试过。）

Answer 1

您可以在README.md中使用permalink：

---
permalink: README.html
---

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

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

您也可以在_config.yml：

中使用front matter defaults

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, ...

Answer 2

我了解到，如果您将任何前缀添加到自述文件中，它会停止将README.md转换为index.html。我通过将这个前端添加到我的README.md

意外地发现了这一点

---
title: Design Your Bot
---

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

2 个答案: