CONTRIBUTING.md不会在github页面上呈现为网页

Question

我正在将contrib.md文件从项目根目录移动到docs /目录，因此它可以与其余文档一起使用。当在github页面中查看时，文档中的其他markdown文件可以正确呈现。例如，页面

https://jtablesaw.github.io/tablesaw/userguide/toc 按预期呈现页面toc.md。

然而，

https://jtablesaw.github.io/tablesaw/contributing

返回404，只需添加.md扩展名

https://jtablesaw.github.io/tablesaw/contributing.md

将页面作为降价源返回

github项目是https://github.com/jtablesaw/tablesaw。 和contributions.md文件位于docs /文件夹中。

Answer 1

在分叉your repo之后，玩了一会儿，然后把头撞到了墙上，因为我不明白它为什么不起作用，我意识到了什么：

Github Pages不支持从Github为其他目的识别名称的文件构建Jekyll页面。这些文件名包括（除了小写版本）：

• CONTRIBUTING.md
• ISSUE_TEMPLATE.md
• PULL_REQUEST_TEMPLATE.md
• ISSUE_AND_PULL_REQUEST_TEMPLATE.md
• CODEOWNERS.md

另一方面，尽管README.md也是一个Github关键字文件，但看起来Github Pages支持使用README.md名称的文件，因为它故意以与index.md相同的方式解释它们。 {1}}或index.html文件。有关详细信息，请参阅this link from the Github blog。

要回答有关如何让文件显示在/tablesaw/contributing路径的具体问题，您可以重命名该文件并将其移至/docs/contributing/index.md或/docs/contributing/README.md路径。

不幸的是，̶至少在现在，̶̶t̶h̶e̶r̶e̶'̶s̶目前还没有办法，使之与相同的文件名且具有GitHub的网页构建一个页面用于̶i̶t̶.̶

编辑： @Master_ex正确地说明您可以使用_config.yml文件中的include configuration option来包含通常被Github排除的文件：

theme:   jekyll-theme-minimal
include: contributing.md

在参考原始示例时，这将允许Github Pages在/docs/contributing路径上成功构建页面。

Answer 2

Zachary的回答是正确的，但有一种方法可以修改jekyll的配置以包含特定的页面。

以下是一个示例：https://masterex.github.io/test-docs/contributing

您必须按如下方式修改_config.yml：

theme: jekyll-theme-minimal
include: contributing.md

Here是github的相关帮助页面。