Unverified Commit 2fa229ac authored by natee's avatar natee Committed by GitHub
Browse files

docs(translation): Update Chinese readme (#225) 

* update Chinese readme

* readme demo usage error
parent 51ba2d20

readme.md

+1 −1
Original line number Diff line number Diff line
@@ -122,7 +122,7 @@ Customization Options: 
| hide_border   | boolean   | hides the stats card border                 | false                | N/A                 | N/A                     |

| show_owner    | boolean   | shows owner name in repo card               | N/A                  | false               | N/A                     |

| show_icons    | boolean   | shows icons                                 | false                | N/A                 | N/A                     |

| theme         | string    | sets inbuilt theme                          | 'default'            | 'default_repocard'  | 'default                |

| theme         | string    | sets inbuilt theme                          | 'default'            | 'default_repocard'  | 'default'               |

| cache_seconds | number    | manually set custom cache control           | 1800                 | 1800                | '1800'                  |

| count_private | boolean   | counts private contributions too if enabled | false                | N/A                 | N/A                     |

| layout        | string    | choose a layout option                      | N/A                  | N/A                 | "default"               |

readme_cn.md

+61 −53
Original line number Diff line number Diff line
@@ -8,6 +8,9 @@ 
    <a href="https://github.com/anuraghazra/github-readme-stats/actions">

      <img alt="Tests Passing" src="https://github.com/anuraghazra/github-readme-stats/workflows/Test/badge.svg" />

    </a>

    <a href="https://codecov.io/gh/anuraghazra/github-readme-stats">

      <img src="https://codecov.io/gh/anuraghazra/github-readme-stats/branch/master/graph/badge.svg" />

    </a>

    <a href="https://github.com/anuraghazra/github-readme-stats/issues">

      <img alt="Issues" src="https://img.shields.io/github/issues/anuraghazra/github-readme-stats?color=0088ff" />

    </a>
@@ -23,6 +26,11 @@ 
    ·

    <a href="https://github.com/anuraghazra/github-readme-stats/issues/new/choose">请求增加功能</a>

  </p>

  <p align="center">

    <a href="readme.md">English</a>

    ·

    <a href="readme_es.md">Español</a>

  </p>

</p>

<p align="center">喜欢这个项目？请考虑<a href="https://www.paypal.me/anuraghazra">捐赠</a>来帮助它完善！
@@ -38,22 +46,35 @@ 
# GitHub 统计卡片



将这行代码复制到你的 markdown 文件中，简单如此！



更改 `?username=` 的值为你的 GitHub 用户名。



```md

[![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)

```



_Note: 排名基于用户的统计信息计算得出，详见 [src/calculateRank.js](./src/calculateRank.js)_

_注: 排名基于用户的统计信息计算得出，详见 [src/calculateRank.js](./src/calculateRank.js)_



### 隐藏个人统计信息

### 隐藏个别统计项



想要隐藏某项统计信息，你可以调用参数 `?hide=`，并调用 你想要隐藏的项目 组成的数组。

想要隐藏指定统计信息，你可以调用参数 `?hide=`，其值用 `,` 分隔。



> 选项：`&hide=["stars","prs","issues","contribs"]`

> 选项：`&hide=stars,commits,prs,issues,contribs`



```md

![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["contribs","prs"])

![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=contribs,prs)

```



### 把私人贡献计数添加到总提交计数中



你可以用参数 `?count_private=true` 把私人贡献计数添加到总提交计数中。



_注：如果你是自己部署本项目，私人贡献将会默认被计数，如果不是自己部署，你需要分享你的私人贡献计数。_



> Options: `&count_private=true`



```md

![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&count_private=true)

```



### 显示图标
@@ -88,51 +109,26 @@ dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontr 


自定义选项：



| Option      | type      | description                          | Stats Card (default) | Repo Card (default) |

| ----------- | --------- | ------------------------------------ | -------------------- | ------------------- |

| title_color | hex color | 标题颜色                              | 2f80ed               | 2f80ed              |

| text_color  | hex color | 字体颜色                              | 333                  | 333                 |

| icon_color  | hex color | 图标颜色                              | 4c71f2               | 586069              |

| bg_color    | hex color | 卡片背景颜色                           | FFFEFE               | FFFEFE              |

| line_height | number    | 文字行高                              | 30                   | N/A                 |

| hide_rank   | boolean   | 隐藏评分等级                           | false                | N/A                 |

| hide_title  | boolean   | 隐藏卡片标题                           | false                | N/A                 |

| hide_border | boolean   | 隐藏卡片边框                           | false                | N/A                 |

| show_owner  | boolean   | 显示 Repo 卡片所属账户用户名             | N/A                  | false               |

| show_icons  | boolean   | 显示图标                              | false                | N/A                 |

| theme       | string    | 设置主题                              | 'default'            | 'default_repocard'  |



---



### Demo



- 默认



![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)



- 隐藏特定数据



![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["contribs","issues"])



- 显示图标



![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["issues"]&show_icons=true)



- 主题



从 [默认主题](#主题) 中进行选择



![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=radical)



- 自定义统计卡片



![Anurag's github stats](https://github-readme-stats.vercel.app/api/?username=anuraghazra&show_icons=true&title_color=fff&icon_color=79ff97&text_color=9f9f9f&bg_color=151515)



- 自定义代码库卡片



![Customized Card](https://github-readme-stats.vercel.app/api/pin?username=anuraghazra&repo=github-readme-stats&title_color=fff&icon_color=f9f9f9&text_color=9f9f9f&bg_color=151515)



---

| Option      | type      | description               | Stats Card (default) | Repo Card (default) | Top Lang Card (default) |

| ----------- | --------- | --------------------------| -------------------- | ------------------- | -------------------  |

| title_color | hex color | 标题颜色                   | 2f80ed               | 2f80ed              | 2f80ed              |

| text_color  | hex color | 字体颜色                   | 333                  | 333                 | 333                 |

| icon_color  | hex color | 图标颜色                   | 4c71f2               | 586069              | 586069              |

| bg_color    | hex color | 卡片背景颜色                | FFFEFE               | FFFEFE              | FFFEFE              |

| line_height | number    | 文字行高                   | 30                   | N/A                 | N/A                 |

| hide        | CSV       | 隐藏指定统计项              | undfined             | N/A                 | undefined          |

| hide_rank   | boolean   | 隐藏评分等级                | false                | N/A                 | N/A                 |

| hide_title  | boolean   | 隐藏卡片标题                | false                | N/A                 | false               |

| hide_border | boolean   | 隐藏卡片边框                | false                | N/A                 | N/A                 |

| show_owner  | boolean   | 显示 Repo 卡片所属账户用户名  | N/A                  | false               | N/A                |

| show_icons  | boolean   | 显示图标                   | false                | N/A                 | N/A                 |

| theme       | string    | 设置主题                   | 'default'            | 'default_repocard'  | 'defaultt'          |

| cache_seconds | number  | 手动设置自定义缓存控制        | 1800                 | 1800               |'1800'            |

| count_private | boolean   | 统计私人贡献计数           | false                | N/A                 | N/A                |

| layout        | string    | 布局方式                  | N/A                  | N/A                 | 'default'          |





> 注意缓存：Repo 卡片默认缓存 30 分钟，如果 fork 数和 star 数小于 1k ，则默认为 2小时。缓存被限制为最少30分钟，最长24小时。



# GitHub 更多置顶
@@ -182,10 +178,22 @@ Endpoint: `api/top-langs?username=anuraghazra` 
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide=语言1,语言2)](https://github.com/anuraghazra/github-readme-stats)

```



### 紧凑的语言卡片布局



你可以使用 `&layout=compact` 参数来改变卡片的样式。



```md

[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=compact)](https://github.com/anuraghazra/github-readme-stats)

```



### Demo



[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)



- 紧凑布局



[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=compact)](https://github.com/anuraghazra/github-readme-stats)



---



### 全部Demo
@@ -196,11 +204,11 @@ Endpoint: `api/top-langs?username=anuraghazra` 


- 隐藏特定数据



![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["contribs","issues"])

![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=contribs,issues)



- 显示图标



![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["issues"]&show_icons=true)

![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=issues&show_icons=true)



- 主题

CRA Git | Maintained and supported by SUSTech CRA and CCSE