【发布时间】：2021-07-18 12:56:45
【问题描述】：
我有一个Github project 和README.md。出于 godoc 的目的，我添加了 doc.go 文件，但并不意味着将 README.md 包含在 godoc 中。目前自述文件显示为first section in godoc。是否可以完全隐藏 README 部分？
【问题讨论】：
-
不，没有。 File an issue 就他们更改包文档结构的决定提供反馈。
【发布时间】：2021-07-18 12:56:45
【问题描述】：
我找到了一个很好的解决方案，只需将您的 README.md 文件放在 docs folder on Github 中，它就不会出现在 godoc 中，但仍会显示在 Github 上。
我为my project on Github 做了这个，你可以看到godoc does not show the README.mdcontent。
编辑：
对您的 github 存储库进行适当的更改后，您需要发布新的补丁版本以获取 pkg.go.dev 以更新更改。
【讨论】：
-
我可以发誓照你说的做，但由于某种原因，现在 README 再次出现在 godoc 上：github.com/sanggonlee/pogo
-
@Iblisto 您可能只需要强制
pkg.go.dev进行更新。我想我过去曾使用go get完成此操作，但如果您显然看这里，您也可以点击一个 URL：github.com/golang/go/issues/38848。让我知道这是否有效，我将使用此信息更新我的答案 -
@Iblisto 我有一些时间并尝试使用它，但无法使用任何方法在
pkg.go.dev上更新它。您可能需要发布补丁版本 (v1.0.1) 以使其更新。你可以试试吗？ -
啊，这似乎奏效了！对不起，我可能没有想对。谢谢！
是否可以完全隐藏 README 部分？
没有。除非您省略该文件或重命名它。
【讨论】：