README.md

说明

这是小康友链仓库，将友链一一记录在data文件夹中

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

你所申请的友链将全部在小康的友链中显示。

提交友链

第一步 fork项目

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

第二步 添加连接

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

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

name: 小康博客
link: https://www.antmoe.com/
avatar: https://cdn.jsdelivr.net/npm/kang-static@latest/avatar.jpg
descr: 一个收藏回忆与分享技术的地方！

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

   

2. 写入内容

   class_name: 测试分组
   class_desc: 这是一个测试使用的分组
   link_list:
     - name: 小康博客
       link: https://www.antmoe.com/
       avatar: https://cdn.jsdelivr.net/npm/kang-static@latest/avatar.jpg
       descr: 一个收藏回忆与分享技术的地方！
       theme:
         style: default
         siteImage:
         

   • class_name

     该分组名称

   • class_desc

     该分组的描述

   • link_list

     连接数组

   • 文件名

     理论上文件名可以随意填写（注意结尾的yml后缀），但是为了方便查找，建议将文件名命名为标签名。

   完整示例参考：乐特专属.yml

   

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

   

4. 进行pull request

   

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

   

   

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

想要自用

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

原gitee友链迁移

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

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

构建

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

Plugins

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

fcircle

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

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