diff --git a/README.md b/README.md index c6c294d71bed704722f7e9c7a1783025fd51f9d6..884bc0d5b6800230ceb2b4473867cecdb6d844a9 100644 --- a/README.md +++ b/README.md @@ -1,116 +1,106 @@ -# 百万人拥开源 - -|[![项目助力](https://codechina.csdn.net/codechina/operation-work/uploads/52a660e13d2e39c26fffdf8605912440/repo.png)](https://codechina.csdn.net/explore/open_source_fest/project)|[![评论助力](https://codechina.csdn.net/codechina/operation-work/uploads/9dd06c74345ed173b1abb9e5010b1b32/comment.png)](https://codechina.csdn.net/explore/open_source_fest/comment)|[![投稿助力](https://codechina.csdn.net/codechina/operation-work/uploads/4153a8efbd83f3b9321727e5a03c0e5e/article.png)](https://codechina.csdn.net/explore/open_source_fest/article)|[![视频助力](https://codechina.csdn.net/codechina/operation-work/uploads/8ff3b21486f88423b059f8d1dba05b2a/video.png)](https://codechina.csdn.net/explore/open_source_fest/video)|[![分享助力](https://codechina.csdn.net/codechina/operation-work/uploads/dc7017e0f3c498d745f7f49927c19e9b/share.png)](https://marketing.csdn.net/p/e6a984013a33d1f7209a282a6d1cbd00)| -|--|---|---|--|---| - - -[示例代码参考](https://codechina.csdn.net/codechina/operation-work/-/snippets/243) - ------ - -# CODE CHINA 运营 - -CODE CHINA 运营仓库是 CODE CHINA 网站上包括 Explore、Topic 以及其他 banner 位的管理仓库。 - -用户可以 Fork 项目并向我们提交合并请求，来申请以下资源的使用（注：申请时请按照已经设置好的 `.yaml` 文件格式来填写，详见下方说明）： - -1. Expoler 发现页 - 1. 申请搜索热词 - 2. 申请活动 banner 图 - 3. 申请入驻组织展示 - 4. 申请精选项目展示 -2. Topic 页 - 1. 申请/创建 Topic - 2. 申请精选 Topic - -## Explore - -项目/组织 Explore 页面中可以配置包括 搜索热词、banner 图、入驻组织、精选项目 等内容。 - -### 搜索热词 - -搜索热词在 `explore/index.yaml` 中 `trending_words` section 进行配置，格式如下： - -```yaml -# 搜索热词 - - content: csdn - link: 'https://www.csdn.net/' - - content: codechina - link: 'https://codechina.csdn.net/' - - content: '组织入驻' - link: 'https://codechina.csdn.net/codechina/help-docs/-/wikis/docs/user/org/star-community-join-plan' -``` - -### Banner 图 - -Banner 图在 `explore/index.yaml` 中 `banner` section 进行配置，Banner 图尺寸要求为 `1248*320px`，配置格式如下： - -```yaml -# banner 图 - - url: 'https://codechina.csdn.net/codechina/operation-work/uploads/700cd15fa181e0582638135e4c1954b3/banner.jpg' - link: '' -``` - -### 入驻组织 - -入驻组织展示在 `explore/index.yaml` 中 `groups` section 进行配置，格式如下： - -```yaml -# 入驻组织 - - jeecg - - mozi - - megvii - - dcloud - - apache - - openanolis - - paddlepaddle - - chatopera - - apachecn - - easycorp -``` - -### 精选项目 - -精选项目在 `explore/index.yaml` 中 `projects` section 进行配置，格式如下： - -```yaml -# 精选项目列表 - - 'dcloud/uni-app' - - 'megvii/megengine' - - 'apache/pulsar' - - 'openanolis/cloud-kernel' - - 'paddlepaddle/Paddle' - - 'chatopera/cskefu' - - 'taosdata/tdengine' - - 'apache/dolphinscheduler' - - 'u012702547/vhr' -``` - -## Topic - -类似百度百科，我们欢迎用户为 Topic 补充相关的信息，包括 logo、描述、官网及博客等信息，同时也可以申请成为精选 Topic，让更多的用户看到这个 Topic。 其配置格式 - -每个 Topic 需要在 `Topic`下创建一个同名的文件夹，同时在其文件下创建一个`index.yaml`配置文件，配置文件内容如下： - -```yaml -# Topic更新 ---- -topic: bootstrap -aliases: 'bootstrap3, bootstrap4, bootstrap-4, bootstrap5, bootstrap-5' -display_name: 'Bootstrap' -selected: false -website: 'https://github.com/twbs' -description: 'Bootstrap is an HTML, CSS, and JavaScript framework.' -logo: 'https://github.com/github/explore/blob/master/topics/bootstrap/bootstrap.png?raw=true' ---- -``` - -其中： - -- `topic` 是指 `Topic`名称，用于 `url`中，将忽略大小写 -- `aliases` 是指 Topic 的别名，即请求访问别名中的任意 Topic 时，展示的 Topic 信息会与当前 Topic 的信息保持一致 -- `dispaly_name` 是指 Topic 页显示的 Topic 名称 -- `selected` 是指精选 Topic -- `website` 是指 Topic 的官网 -- `description` 是指 Topic 的描述 -- `logo` 是指 Topic 的 logo，建议大小为`110*110px`，需填写图片的绝对地址 +# GitCode 运营仓库 + +GitCode 运营仓库是 GitCode 网站上包括 Explore、Topic 以及其他 banner 位的管理仓库。 + +用户可以 Fork 项目并向我们提交合并请求，来申请以下资源的使用（注：申请时请按照已经设置好的 `.yaml` 文件格式来填写，详见下方说明）： + +1. Expoler 发现页 + 1. 申请搜索热词 + 2. 申请活动 banner 图 + 3. 申请入驻组织展示 + 4. 申请精选项目展示 +2. Topic 页 + 1. 申请/创建 Topic + 2. 申请精选 Topic + +## Explore + +项目/组织 Explore 页面中可以配置包括 搜索热词、banner 图、入驻组织、精选项目 等内容。 + +### 搜索热词 + +搜索热词在 `explore/index.yaml` 中 `trending_words` section 进行配置，格式如下： + +```yaml +# 搜索热词 + - content: csdn + link: 'https://www.csdn.net/' + - content: GitCode + link: 'https://gitcode.net/' + - content: '组织入驻' + link: 'https://gitcode.net/gitcode/help-docs/-/wikis/docs/user/org/star-community-join-plan' +``` + +### Banner 图 + +Banner 图在 `explore/index.yaml` 中 `banner` section 进行配置，Banner 图尺寸要求为 `1248*320px`，配置格式如下： + +```yaml +# banner 图 + - url: 'https://gitcode.net/gitcode/operation-work/uploads/700cd15fa181e0582638135e4c1954b3/banner.jpg' + link: '' +``` + +### 入驻组织 + +入驻组织展示在 `explore/index.yaml` 中 `groups` section 进行配置，格式如下： + +```yaml +# 入驻组织 + - jeecg + - mozi + - megvii + - dcloud + - apache + - openanolis + - paddlepaddle + - chatopera + - apachecn + - easycorp +``` + +### 精选项目 + +精选项目在 `explore/index.yaml` 中 `projects` section 进行配置，格式如下： + +```yaml +# 精选项目列表 + - 'dcloud/uni-app' + - 'megvii/megengine' + - 'apache/pulsar' + - 'openanolis/cloud-kernel' + - 'paddlepaddle/Paddle' + - 'chatopera/cskefu' + - 'taosdata/tdengine' + - 'apache/dolphinscheduler' + - 'u012702547/vhr' +``` + +## Topic + +类似百度百科，我们欢迎用户为 Topic 补充相关的信息，包括 logo、描述、官网及博客等信息，同时也可以申请成为精选 Topic，让更多的用户看到这个 Topic。 其配置格式 + +每个 Topic 需要在 `Topic`下创建一个同名的文件夹，同时在其文件下创建一个`index.yaml`配置文件，配置文件内容如下： + +```yaml +# Topic更新 +--- +topic: bootstrap +aliases: 'bootstrap3, bootstrap4, bootstrap-4, bootstrap5, bootstrap-5' +display_name: 'Bootstrap' +selected: false +website: 'https://github.com/twbs' +description: 'Bootstrap is an HTML, CSS, and JavaScript framework.' +logo: 'https://github.com/github/explore/blob/master/topics/bootstrap/bootstrap.png?raw=true' +--- +``` + +其中： + +- `topic` 是指 `Topic`名称，用于 `url`中，将忽略大小写 +- `aliases` 是指 Topic 的别名，即请求访问别名中的任意 Topic 时，展示的 Topic 信息会与当前 Topic 的信息保持一致 +- `dispaly_name` 是指 Topic 页显示的 Topic 名称 +- `selected` 是指精选 Topic +- `website` 是指 Topic 的官网 +- `description` 是指 Topic 的描述 +- `logo` 是指 Topic 的 logo，建议大小为`110*110px`，需填写图片的绝对地址