从Github项目的godoc中排除自述部分

Question

我有一个 Github 项目。出于 godoc 的目的，我添加了 file，但无意将 godoc 包含在 godoc 中。目前，自述文件显示为godoc中的第一部分。是否可以隐藏自述文件部分？README.mddoc.goREADME.md

Answer 1

我找到了一个很好的解决方案，只需将你的文件放在Github上的文档文件夹中，它就不会显示在godoc中，但仍然显示在Github上。README.md

我在Github上为我的项目做了这个，你可以看到godoc没有显示 README.md内容。

编辑：

对 github 存储库进行适当的更改后，您需要发布新的修补程序版本才能使用更改进行更新。pkg.go.dev

Answer 2

是否可以隐藏自述文件部分？

不。除非您省略该文件或重命名它。