Skip to content

Latest commit

 

History

History
206 lines (142 loc) · 7.24 KB

README.zh-Hans.md

File metadata and controls

206 lines (142 loc) · 7.24 KB

GitHub GitHub GitHub Repo stars GitHub release (latest by date including pre-releases) GitHub user Pre Build Gitter

国际化

English | 简体中文

内容目录

点我 打开/关闭 目录列表

项目介绍

此项目是一个 Github 示例仓库模板,主要内容为 README 的示例模板。

官方网站

官网地址

背景

在开源社区寻找所需要的工具和库的时候,发现有很多优秀的代码库,但是没有一个好的 README 文件或者使用教程,导致使用者需要花额外的时间去学习如何使用它,所以本项目提供了一个标准的代码库范本,希望可以帮助到他人。

图形演示

单击 Gif 查看完整演示

功能特色

  • 项目 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 符合标准存储库,您可以添加一个徽章链接回此规范,以帮助其他人采用此自述文件。

符合 yakia 的自述文件

以 Markdown 格式添加,请使用以下代码:

[![符合 yakia 的自述文件](https://cdn.jsdelivr.net/gh/misitebao/yakia/assets/badge_flat-square.svg)](https://github.com/misitebao/yakia)

以 HTML 格式添加,请使用以下代码:

<a href="https://github.com/misitebao/yakia">
  <img
    alt="GitHub"
    src="https://cdn.jsdelivr.net/gh/misitebao/yakia/assets/badge_flat-square.svg"
  />
</a>

请自行修改文件名以获取你想要的样式:

文件名 样式预览
badge_flat-square.svg 符合 yakia 的自述文件
badge_flat.svg 符合 yakia 的自述文件
badge_for-the-badge.svg 符合 yakia 的自述文件
badge_plastic.svg 符合 yakia 的自述文件
badge_social.svg 符合 yakia 的自述文件

维护者

感谢这些项目的维护者:

misitebao

点我 打开/关闭 维护者列表

贡献者

感谢所有参与 yakia 开发的贡献者。贡献者列表

crushonyou18

社区交流

  • Gitter - 一个公开的即时聊天工具。

部分用户

如果你的项目使用了此规范,你可以 Fork 此项目并提交 PR 将您的项目添加在此列表,以便于让其他人知道您的项目。

版权许可

License MIT