Skip to content

预置模板

Linxs edited this page Sep 15, 2020 · 4 revisions

项目推荐模板参考

开源项目的推荐模板可参考如下格式,主要是为了方便信息采集以及入选排期时可以快速排版以及样式的更新

麻烦各位参与推荐的小伙伴尽量遵守。可以直接复制使用以下版式(markdwon)进行编写。

<!--
Language:
Tags:
此处请填写并保留作为信息采集用途
-->
# 开源项目名称

项目简介内容 blablabla……

项目仓库:[仓库名](仓库URL)
项目文档:[README.md](README.md URL)

语言:Java
标签:微服务 | 框架 | ……

<!--
  此处 HTML 代码为 Watchers、Stars、Forks 显示代码,替换{项目路径}为项目仓库地址 path
  例如:
    cube-ui 仓库地址:https://github.com/didi/cube-ui

    替换:{项目路径} -> didi/cube-ui
    https://github.com/didi/cube-ui/watchers
-->
<p>
  <a title="GitHub Watchers" target="_blank" href="https://github.com/{项目路径}/watchers"><img alt="GitHub Watchers" src="https://img.shields.io/github/watchers/{项目路径}.svg?label=Watchers&style=social"></a>  
  &nbsp;
  <a title="GitHub Stars" target="_blank" href="https://github.com/{项目路径}/stargazers"><img alt="GitHub Stars" src="https://img.shields.io/github/stars/{项目路径}.svg?label=Stars&style=social"></a>  
  &nbsp;
  <a title="GitHub Forks" target="_blank" href="https://github.com/all-contributors/{项目路径}/network/members"><img alt="GitHub Forks" src="https://img.shields.io/github/forks/{项目路径}.svg?label=Forks&style=social"></a>
</p>

## 推荐理由
推荐的理由 blablabla……

以及罗列其特性特点
1. 特点……
2. ……
3. ……

## 项目展示
描述该项目可用场景 blablabla……

### 示例代码(可选)
该项目的使用方式或示例代码

### 效果展示(可选)
![](./效果截图.png)


<!-- 如果有则更改为您的掘金文章地址,用于导流 -->
> 掘金优秀开源推荐:[文章标题](https://juejin.im/post/文章id)
> 
> 掘金开源计划 ISSUE:[提交的 ISSUE 标题](提交的ISSUE地址)