开源Git存储库模板
此项目是一个 Github 示例仓库模板,主要内容为 README 的示例模板。
在开源社区寻找所需要的工具和库的时候,发现有很多优秀的代码库,但是没有一个好的 README 文件或者使用教程,导致使用者需要花额外的时间去学习如何使用它,所以本项目提供了一个标准的代码库范本,希望可以帮助到他人。
- 项目 logo 以及相应数据居中展示
- 提供多语言功能以及示例模板
- README 文件必备的说明
- 内置目录导航功能,解决部分 Markdown 解析引擎不能正确解析导航的问题
|—— .gitee Gitee 配置文件
| |—— ISSUE_TEMPLATE.md Gitee Issue 模板
| |—— PULL_REQUEST_TEMPLATE.md Gitee PR 模板
|—— .github Github 配置文件
| |—— ISSUE_TEMPLATE Github Issue 模板
| | |—— issue-template-bug.md Github Issue Bug 模板
| | |—— issue-template-feature.md Github Issue Feature 模板
| |—— workflows Github 工作流
| | |—— deploy-for-hugo.yml Github 工作流 Hugo 示例
| | |—— deploy-for-nodejs.yml Github 工作流 NodeJS 示例
| |—— pull-request-template.md Github PR 模板
|—— website 项目网站
|—— CHANGELOG.md 发布日志
|—— LICENSE 许可证
|—— README.md 英语 README
|—— README.zh-Hans.md 其他语言 README
|—— README.tmpl.md README 模板
点我 查看模板文件,再点击编辑即可复制模板内容。
如果您的 README 符合标准存储库,您可以添加一个徽章链接回此规范,以帮助其他人采用此自述文件。
以 Markdown 格式添加,请使用以下代码:
[![符合 standard-repository 的自述文件](https://img.shields.io/badge/Readme--Style-standard--repository-brightgreen?style=flat-square&color=f83500)](https://github.com/misitebao/standard-repository)
以 HTML 格式添加,请使用以下代码:
<a href="https://github.com/misitebao/standard-repository">
<img
alt="GitHub"
src="https://img.shields.io/badge/Readme--Style-standard--repository-brightgreen?style=flat-square&color=f83500"
/>
</a>
感谢这些项目的维护者:
点我 打开/关闭 贡献者列表
- 米司特包 - 项目作者,全栈工程师。
感谢所有参与 standard-repository 开发的贡献者。贡献者列表
- Gitter - 一个公开的即时聊天工具。
- Tigago - 一个基于 Go 语言的模块化框架
- wails-template-vue - 基于 Vue 和 Vue-Router 的 Wails 模板
如果你的项目使用了此规范,你可以 Fork 此项目并提交 PR 将您的项目添加在此列表,以便于让其他人知道您的项目。