-
Notifications
You must be signed in to change notification settings - Fork 207
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
使用模板替换部分 README 中的内容 #12
Conversation
在actions中我还配置有两个动作,都是操作README的,一个是自动生成TOC,一个是自动生成贡献者列表,不知道这样拆成模块儿化之后,这三个会不会有冲突 |
看看是否可以配置修改的文件为 |
生成贡献者列表应该没问题,生成TOC是根据README里的目录层级生成的,应该不行 |
这个感觉上好像也没问题,当通过 可以考虑把这些都放在一个 aciton 里,最后统一提交代码仓库更新,就不会有问题了。 |
LinuxSuRen/yaml-readme#8 这个 PR 可以支持 |
对了,TOC、contributor 列表这些其实也算是 README 里常见的需求,可以考虑把这两个功能也都在 |
LinuxSuRen/yaml-readme#12 这个 PR 已经实现了 TOC 的功能,使用起来也非常方便。
这里有示例 https://github.com/linuxsuren-bot/test/tree/1f83e9e650a0ad54fca164d7593ef4deba4bf053#usage |
LinuxSuRen/yaml-readme#13 可以支持获取贡献者列表,效果图如下 |
感谢辛勤劳动,明天我会进行测试,如有问题,再行沟通 |
目前看起来一些排序方面的问题还有点麻烦,所以暂时不采纳了 |
通过 https://github.com/LinuxSuRen/yaml-readme 这个项目可以简化 README 的维护,如果感觉可以的话,可以考虑把整个 README 都模板化。
合并该 PR 之前需要添加下面的 Secret 到该仓库:
GH_SECRETS=您的 GitHub Token