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

我正在使用Jekyll在Github Pages上使用“Dinky”主题构建项目网页，。Tell Jekyll（在github页面上）将README.md转换为README.html，而不是index.html

README.md会自动转换为index.html，这对快速入门非常有帮助。

不过，我想有一个单独编写的主页index.md，而是转换到README.mdREADME.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设置是该网站的Gemfile中的gem 'github-pages', group: :jekyll_plugins，以及该网站的_config.yml中的theme: jekyll-theme-dinky。

它似乎是特定于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后都试过有和没有周围的文件名引号，和）

来源

2017-05-10 PLL

访问Github上时Readme.md显示在回购的根简要概述，但他们都不在哲基尔网站 – marcanuy

生成的index.html @marcanuy：我知道Jekyll通常不会将'README.md'转换为'index.html'，但是当使用带有主题的Github Pages时，我向你保证。我将编辑我的答案以澄清我尝试过的内容，但是简要地说，这发生在本地构建中，并且通过Github Pages提供时，除了用于Github Pages主题的设置之外，我没有任何本地自定义设置。 – PLL

我无法复制它，从来没有看到README.md被转换为'index.html'。 – marcanuy

您可以使用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一个前面的问题，使之由杰基尔（即使是空的）解析：

--- 
--- 

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

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

来源

2017-05-11 19:59:43 wasthishelpful

我了解到，如果添加任何 frontmatter自述，它停止转动README.md到的index.html。我发现这个意外加入这个frontmatter我README.md

--- 
title: Design Your Bot 
---

来源

2017-11-06 20:36:14 Melissa

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

回答

相关问题