从 Github 项目的 godoc 中排除 README 部分
来源：stackoverflow
时间：2024-04-18 15:15:37 183浏览 收藏
来到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学习网公众号了解相关技术文章。
声明：本文转载于：stackoverflow 如有侵犯，请联系study_golang@163.com删除
相关阅读
更多>
-
502 收藏
-
502 收藏
-
501 收藏
-
501 收藏
-
501 收藏
最新阅读
更多>
-
Golang · Go问答 | 1天前 | 并发 · channel · Mutex · 性能优化 · Go问答 · benchmark · Goroutine channel Mutex 并发性能 锁等待 benchmark Go问答268 收藏
-
Golang · Go问答 | 1天前 | 并发 · map · RWMutex · sync.Map · Go问答 · 数据竞争 RWMutex sync.Map map并发读写 Go问答 concurrent map read and map write291 收藏
-
Golang · Go问答 | 1天前 | 并发 · channel · range · Close · Go问答 · 并发退出 Channel关闭 Go问答 close channel range退出 发送方关闭427 收藏
-
Golang · Go问答 | 1天前 | goroutine · HTTP · Context · 超时控制 · Go问答 · WithTimeout Go问答 context取消 QueryContext HTTP请求取消 goroutine退出120 收藏
-
Golang · Go问答 | 1天前 | goroutine · pprof · Go问答 · 线上排查 · 性能调优 · pprof goroutine泄漏 服务告警 Go问答 context取消 Go线上排查374 收藏
-
Golang · Go问答 | 1天前 | goroutine · Context · 超时控制 · Go问答 · 协程泄漏 · Go Goroutine 超时控制 context.WithTimeout 取消信号 协程泄漏 ctx.Done147 收藏
-
Golang · Go问答 | 1天前 | 闭包 · go · Go问答 · 循环变量 · Go1.22 · 代码迁移 · 闭包 循环变量 go vet Go问答 Go 1.22 for range loopclosure356 收藏
-
127 收藏
-
449 收藏
-
Golang · Go问答 | 2天前 | sync.Pool · reset · 对象复用 · Go问答 · 线上排查 · Go sync.Pool Go问答 sync.Pool串数据 Reset清理 对象池复用342 收藏
-
Golang · Go问答 | 2天前 | 标准库 · 文件读取 · io.Reader · Go问答 · io.EOF · Go read io.Reader io.EOF Go问答 n err 读取循环486 收藏
-
181 收藏
课程推荐
更多>
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案，代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景，打造一站式知识长龙服务，适合有JS基础的同学学习。
- 立即学习 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例，全面具体可落地，从理论到实践，一步一步将GO核心编程技术、编程思想、底层实现融会贯通，使学习者贴近时代脉搏，做IT互联网时代的弄潮儿。
- 立即学习 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信：Le-studyg；在课程中，我们将首先介绍MySQL8的新特性，包括性能优化、安全增强、新数据类型等，帮助学生快速熟悉MySQL8的最新功能。接着，我们将深入解析MySQL的网络通信机制，包括协议、连接管理、数据传输等，让
- 立即学习 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网，分为导航，轮播，关于我们，成功案例，服务流程，团队介绍，数据部分，公司动态，底部信息等内容区块。网站整体采用CSSGrid布局，支持响应式，有流畅过渡和展现动画。
- 立即学习 485次学习