## 说明

这是[ZYKJ](https://zykj.js.org/link)友链仓库，将友链一一记录在`data`文件夹中

上述教程仅为演示 不建议各位互换友链的小伙伴新建文件进行合并后，建议各位小伙伴选择已有标签进行合并。

你所申请的友链将全部在[友链](https://zykj.js.org/link/)中显示。

本项目还增加了友链截图功能(链接必须是`https`开头)，可以在[gh-pages](https://gcore.jsdelivr.net/gh/zykjofficial/my-friend@gh-pages/)这里查看。

注意：因为`CDN缓存`问题，更新可能会有较大延迟，还请见谅。

## 提交友链

### 第一步 fork项目

第一步，进入仓库并点击fork

![image-20220212172632781](https://file.acs.pw/picGo/2022/02/12/20220212172802.png)

### 第二步 添加连接

![image-20220212172859359](https://file.acs.pw/picGo/2022/02/12/20220212172859.png)

进入data目录，找到你想添加的分组，并单击文件。（如果没有，可以点击右上方的`Add file`按钮进行新增）

例如，我添加如下友链到新的文件`测试.yml`

```yaml
name: ZYKJ's Blog
link: https://zykj.js.org/
avatar: https://gcore.jsdelivr.net/gh/zykjofficial/zykjofficial.github.io@master/img/avatar.png
descr: 做一个普普通通的人.
```



1. 点击`Add file`按钮，并选择`Create new file`按钮

   ![image-20220212173144260](https://file.acs.pw/picGo/2022/02/12/20220212173144.png)

2. 写入内容

   ```yaml
   class_name: 测试分组
   class_desc: 这是一个测试使用的分组
   link_list:
     - name: ZYKJ's Blog
       link: https://zykj.js.org/
       avatar: https://gcore.jsdelivr.net/gh/zykjofficial/zykjofficial.github.io@master/img/avatar.png
       descr: 做一个普普通通的人.
       theme:
         style: default
         siteImage:
         
   ```

   > - `class_name`
   >
   >   该分组名称
   >
   > - `class_desc`
   >
   >   该分组的描述
   >
   > - `link_list`
   >
   >   连接数组
   >
   > - 文件名
   >
   >   理论上文件名可以随意填写（注意结尾的yml后缀），但是为了方便查找，建议将文件名命名为标签名。

   > 完整示例参考：[乐特专属.yml](https://github.com/kkfive/my-friend/blob/master/data/%E4%B9%90%E7%89%B9%E4%B8%93%E5%B1%9E.yml)

   ![image-20220212173552246](https://file.acs.pw/picGo/2022/02/12/20220212173552.png)

3. 点击下方的按钮 提交文件到自己的仓库

   ![image-20220212173729095](https://file.acs.pw/picGo/2022/02/12/20220212173729.png)

4. 进行pull request

   ![image-20220212173834131](https://file.acs.pw/picGo/2022/02/12/20220212173834.png)

   点击`Open pull request`按钮后将跳转我的仓库，检查无误后即可`Create pull request`

   ![image-20220212174042068](https://file.acs.pw/picGo/2022/02/12/20220212174042.png)

   ![image-20220212174119470](https://file.acs.pw/picGo/2022/02/12/20220212174119.png)

   

5. 等待主人合并分支后，在主人的友链页即可看到你的友链



## 想要自用

如果你想通过此种方式进行友链互换，那么你也可以将此仓库进行fork。

### 原gitee友链迁移

将此仓库fork后，然后将此仓库拉取到本地。

1. 查看`src/transfer.js`文件，将第50行附近的连接修改为你的gitee友链json地址。
2. 运行`npm install && npm run transfer`即可在data文件生成文件。
3. 根据你的需要修改文件名即可

### 构建

将你迁移后的文件推送到GitHub后，只需要在`vercel`部署时修改构建命令和产物目录即可。cf pages同理 例如：

![image-20220212175154310](https://file.acs.pw/picGo/2022/02/12/20220212175154.png)

![image-20220212175232232](https://file.acs.pw/picGo/2022/02/12/20220212175232.png)


## Plugins

此部分主要用于生成基于友链的一些扩展信息文件，例如用于友链朋友圈的`SETTINGS_FRIENDS_LINKS.json_api`配置。

### fcircle

用于友链朋友圈的扩展文件生成。默认将所有友链都加入文件中，如果单独屏蔽某个链接，只需要在友链中写入字段`banSub`即可。例如：

```yaml
link_list:
  - avatar: 
    description: 
    link: 
    name: 
    # 是否禁用友链爬虫（true表示不加入友链爬虫队列，false表示加入爬虫队列）
    banSub: true
    # 自定义后缀，对应友链爬虫的suffix字段
    subSuffix: atom.xml
```