Markdown 为什么一些静态站点生成器使用README.md而不是index.md？

为什么静态站点生成器使用index.md以外的任何东西作为站点的根页面？这看起来很自然，但例如VuePress和GitHub希望使用README.md。我正在努力理解这个原因，因为我在另一个SSG的工作

为什么一些静态站点生成器使用README.md而不是index.md

因为存储库主机对自述文件进行了特殊处理。例如，当用户浏览源文件时，GitHub、Bitbucket、GitLab等都会显示目录的自述文件。在某些情况下，如果没有自述，宿主站点甚至会提出抗议

当然，自述文件的内容通常与索引文件中的内容相同。当然，用户不希望维护两个具有相同内容的独立文件。如果是这样，静态站点生成器在构建站点时需要排除自述文件。因此，用户要求，静态站点生成器添加了使用自述文件作为目录索引文件的选项。它使源文件更干净，并保持干燥（不要重复自己）

就我个人而言，我自己从来都不需要这个功能（在GitHib上浏览源文件时，我对缺少的自述文件漠不关心，等等）。然而，作为MkDocs（一个静态站点生成器）的开发人员之一，在我们添加它之前，这是最受欢迎的特性之一。既然它存在了，我们就什么也没听到。我们需要做的一个调整是，如果索引文件也存在于同一目录中，则确保忽略自述文件（显然，有些用户维护两个文件，每个文件的内容不同——在这种情况下，自述文件的内容通常不会包含在构建的网站中；然而，这似乎是最罕见的用例）。看来，只要该功能得到正确实施，那些希望该功能毫无问题地使用它的人，以及那些不需要该功能的人，都不会被它的存在绊倒

为什么一些静态站点生成器使用README.md而不是index.md

因为存储库主机对自述文件进行了特殊处理。例如，当用户浏览源文件时，GitHub、Bitbucket、GitLab等都会显示目录的自述文件。在某些情况下，如果没有自述文件，主机站点甚至会提出抗议

当然，自述文件的内容通常与索引文件中的内容相同。当然，用户不希望维护两个具有相同内容的单独文件。如果他们这样做，静态站点生成器需要在构建站点时排除自述文件。因此，用户要求使用、和静态站点生成器添加使用自述文件作为目录索引文件的选项。它使源文件更干净，并保持干燥（不要重复）

就我个人而言，我自己从来都不需要这个功能（我对在GitHib上浏览源文件时丢失的自述文件漠不关心，等等）。然而，作为MkDocs（静态站点生成器）的开发人员之一，这是我们添加它之前要求最多的功能之一。现在它已经存在，我们对此一无所知。我们需要做的一个调整是，如果同一目录中也存在索引文件，则确保忽略自述文件（显然，有些用户维护两个文件，每个文件的内容不同——在这种情况下，自述文件的内容通常不会包含在构建的网站中；然而，这似乎是最罕见的用例）。看来，只要该功能得到正确实施，那些希望该功能毫无问题地使用它的人，以及那些不需要该功能的人，都不会被它的存在绊倒