从 Github 项目的 godoc 中排除 README 部分

来到golang学习网的大家，相信都是编程学习爱好者，希望在这里学习Golang相关编程知识。下面本篇文章就来带大家聊聊《从 Github 项目的 godoc 中排除 README 部分》，介绍一下，希望对大家的知识积累有所帮助，助力实战开发！

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

正确答案

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

我为 my project on Github 执行此操作，您可以看到 godoc does not show the README.mdcontent。

编辑：

对 github 存储库进行适当更改后，您将需要发布新的补丁版本以使 pkg.go.dev 更新更改。

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

文中关于的知识介绍，希望对你的学习有所帮助！若是受益匪浅，那就动动鼠标收藏这篇《从 Github 项目的 godoc 中排除 README 部分》文章吧，也可关注golang学习网公众号了解相关技术文章。