README.md 3.1 KB
Newer Older
M
miykael 已提交
1
# CODE CHINA 运营
M
miykael 已提交
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21

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 图、入驻组织、精选项目 等内容。

### 搜索热词

M
update  
miykael 已提交
22
搜索热词在 `explore/index.yaml``trending_words` section 进行配置,格式如下:
M
miykael 已提交
23 24 25

```yaml
# 搜索热词
M
update  
miykael 已提交
26 27 28 29 30 31
  - 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'
M
miykael 已提交
32 33 34 35
```

### Banner 图

M
update  
miykael 已提交
36
Banner 图在 `explore/index.yaml``banner` section 进行配置,Banner 图尺寸要求为 `1248*320px`,配置格式如下:
M
miykael 已提交
37 38 39

```yaml
# banner 图
M
update  
miykael 已提交
40 41
  - url: 'https://codechina.csdn.net/codechina/operation-work/uploads/700cd15fa181e0582638135e4c1954b3/banner.jpg'
    link: ''
M
miykael 已提交
42 43 44 45
```

### 入驻组织

M
update  
miykael 已提交
46
入驻组织展示在  `explore/index.yaml``groups` section 进行配置,格式如下:
M
miykael 已提交
47 48 49

```yaml
# 入驻组织
M
update  
miykael 已提交
50 51 52 53 54 55 56 57 58 59
  - jeecg
  - mozi
  - megvii
  - dcloud
  - apache
  - openanolis
  - paddlepaddle
  - chatopera
  - apachecn
  - easycorp
M
miykael 已提交
60 61 62 63
```

### 精选项目

M
update  
miykael 已提交
64
精选项目在 `explore/index.yaml``projects` section 进行配置,格式如下:
M
miykael 已提交
65 66 67

```yaml
# 精选项目列表
M
update  
miykael 已提交
68 69 70 71 72 73 74 75 76
  - 'dcloud/uni-app'
  - 'megvii/megengine'
  - 'apache/pulsar'
  - 'openanolis/cloud-kernel'
  - 'paddlepaddle/Paddle'
  - 'chatopera/cskefu'
  - 'taosdata/tdengine'
  - 'apache/dolphinscheduler'
  - 'u012702547/vhr'
M
miykael 已提交
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
```

## 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`,需填写图片的绝对地址