提交 6c03d7f7 编写于 作者: M miykael

readme update

上级 1c545064
# CodeChina Explore
# 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/config.yaml``xxx` section 进行配置,格式如下:
```yaml
# 搜索热词
- word:""
- url:""
```
### Banner 图
Banner 图在 `Explore/config.yaml``xxx` section 进行配置,Banner 图尺寸要求为 `1248*320px`,配置格式如下:
```yaml
# banner 图
```
### 入驻组织
入驻组织展示在 `Explore/config.yaml``xxx` section 进行配置,格式如下:
```yaml
# 入驻组织
```
### 精选项目
精选项目在 `Explore/config.yaml``xxx` section 进行配置,格式如下:
```yaml
# 精选项目列表
```
## 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`,需填写图片的绝对地址
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册