GitHub 认可哪些文件名作为 README 文件？

Question

5

我知道GitHub识别多个文件名作为README，比如README，README.md等。
这些文件名的完整列表是什么？

- Joris Limonier

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Xiang · Accepted Answer

2

我找到了一个搜索规则

const PATTERN = /^readme\.(?:markdown|mdown|mkdn|md|textile|rdoc|org|creole|mediawiki|wiki|rst|asciidoc|adoc|asc|pod|txt)/i

- Xiang

1

我不擅长正则表达式，你能否帮忙翻译一下？ - Joris Limonier

2

是的，您的理解是正确的，另外还要忽略大小写 /i。 - Xiang

不是，我有那个链接，但我的意思是，这是GitHub用来查找文件是否为readme的函数，还是某个人创建了一个规则来查找readme的存储库？ - Joris Limonier

1

我猜这不是一个官方的存储库，但它仍然可以揭示Github如何搜索README文件。如果你真的想知道Github如何准确地搜索README文件，你可以看一下readme，然后进一步了解18F，再到uswds。 - Xiang

@JorisLimonier，它们最终都将指向https://designsystem.digital.gov/，这是一个标准的美国政府规则。 - Xiang

显示剩余3条评论