Skip to content

Latest commit

 

History

History
161 lines (121 loc) · 6.3 KB

README.zh-Hans.md

File metadata and controls

161 lines (121 loc) · 6.3 KB

Yakia

GitHub GitHub CodeFactor Go Reference Go Report Card Pre Build Slack
GitHub tag (latest SemVer pre-release) npm Crates.io

内容目录

点我 打开/关闭 目录列表

项目介绍

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

官方网站

官网地址

背景

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

功能

  • 项目 logo 以及相应数据居中展示
  • 提供多语言功能以及示例模板
  • README 文件必备的说明
  • 内置目录导航功能,解决部分 Markdown 解析引擎不能正确解析导航的问题

快速入门

如果您的 README 符合标准存储库,您可以添加一个徽章链接回此规范,以帮助其他人采用此自述文件。

符合 Yakia 的自述文件

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

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

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

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

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

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

维护者

感谢这些项目的维护者:

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

贡献者

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

eighteenzheng

部分用户

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

许可证

License MIT

FOSSA Status