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

PLL*_*PLL 6 github jekyll github-pages

我正在使用 Jekyll 构建一个项目网页,在 Github Pages 上,使用“Dinky”主题,开箱即用。

README.md被自动转换为index.html,这是快速入门非常有帮助。

但是,我想要一个单独编写的主页index.md,而是转换README.mdREADME.html(就像大多数*.md文件一样)。当我加我index.md,杰基尔将其转换为index.html如希望的那样,但现在所有的没有给出转换README.md-大概是它index.html的目标都README.mdindex.md,而后者获胜。

我如何告诉 Jekyll 返回使用README.html作为其转换目标README.md

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

复制它的注意事项:所有这些都发生在通过 Github Pages 在线构建时,以及使用本地jekyll build. 唯一的自定义设置杰基尔我用的是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"
Run Code Online (Sandbox Code Playgroud)

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

was*_*ful 5

您可以在以下位置使用永久链接README.md

---
permalink: README.html
---

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

Code  on C-systems, D-systems, ...
Run Code Online (Sandbox Code Playgroud)

您也可以使用前面的问题默认在您的_config.yml

defaults:
  - 
    scope:
      path: "README.md"
    values:
      permalink: "README.html"
Run Code Online (Sandbox Code Playgroud)

但是你仍然需要一个前端README.md来让它被 jekyll 解析(即使它是一个空的):

---
---

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

Code  on C-systems, D-systems, ...
Run Code Online (Sandbox Code Playgroud)


小智 5

我了解到,如果您在自述文件中添加任何frontmatter,它就会停止将 README.md 转换为 index.html。我通过将此 frontmatter 添加到我的 README.md 中偶然发现了这一点

---
title: Design Your Bot
---
Run Code Online (Sandbox Code Playgroud)