基于Butterfly主题添加友链截图

最后更新时间为 2021-01-22 (暂停更新相关内容)

灵感来源

之前在Buttrfly群里看到有人问网站截图API、然后想起 ChenYFan 大佬有关于友链截图的项目、并且友链和Butterfly的友链页面类似，于是就写了一个爬取博客友链截图的小项目：https://github.com/zykjofficial-actions/screen_shot

具体效果：

使用技术

Python (正则和requests)
Github Actions(用于每周定时执行)

使用Python获取博客的友链和Gitee Issue的友链(如果有)并且截图

基本介绍

本项目是基于 ChenYFan 大佬的项目修改而成
参考 baidu-url-submit-by-using-sitemap 的 Github Action 配置
截图网站为：https://www.thum.io/ 、具体使用可以查看官网官方文档：https://www.thum.io/documentation/api/url
Gitee Issue友链教程：https://www.tzki.cn/posts/e01152f6/index.html (旧版) https://www.yuque.com/kdoc/bf/friend (新版) 感谢小康大佬写的Gitee友链
感谢大神： CC康纳百川大神的图片压缩教程：博客图片的 webp 之路、使得图片体积更小

访问我的友链查看效果

简单原理

curl 命令下载图片:

图片大小比较小

1	curl https://image.thum.io/get/width/400/crop/800/allowJPG/wait/20/noanimate/https://<YourDomain>/ -o <YourDoamin>.jpg

图片大小比较大

1	curl https://image.thum.io/get/width/1024/crop/768/https://<YourDomain>/ -o <YourDoamin>.jpg

可以在https://cdn.jsdelivr.net/gh/zykjofficial-actions/screen_shot@gh-pages/ 查看友链图片 可能不适配pjax

使用

fork https://github.com/zykjofficial-actions/screen_shot
在 https://github.com/settings/tokens ，Generate new token、名字随便填、勾选 repo、再点击Generate token 复制好token、在这个仓库Settings > Secrets > new New secret、Name 中填写 TOKEN，Value 为生成的token。(放入 Secrets 中能防止 token 泄露) (默认存在一个TOKEN、可以不需要创建)

编辑 screen_shot.py

if __name__ == '__main__':
    getLinkFriends("https://blog.zykjofficial.top/link/")
    getGiteeFriends("zykjofficial", "friends")
    downloadFriends()

将getLinkFriends函数里的内容替换成你自己的友链页面
将getGiteeFriends函数里替换成 gitee用户名、ISSUE仓库、如果你不使用Gitee Issue友链、请将这一行用#注释
如果你使用的是其他截图网站API、downloadFriends第一个参数为截图网站API、格式类似https://image.thum.io/get/width/400/crop/800/allowJPG/wait/20/noanimate/https://、第二个参数为下载图片的后缀(默认jpg),或者类似https://s0.wordpress.com/mshots/v1/https://zykj.js.org?w=1280&h=960的API、第一个参数为截图网站前缀https://s0.wordpress.com/mshots/v1/https://、第二个参数为截图网站后缀?w=1280&h=960、第三个参数为下载图片的后缀(默认jpg)

修改完成你的配置、就可以在Action查看是否运行成功

配置

注意：此操作只支持Butterfly主题 ：鼠标放在友链上可以显示友链截图

灵感来自: https://blog.cyfan.top/links/ 不过是通过JS来操作

如果Butterfly主题开启了pjax、建议排除以免出现问题

pjax:
  enable: true
  exclude:
    - /link/ # link是我的友链页面

针对新版：https://cdn.jsdelivr.net/npm/butterfly-friend@latest/dist/friend.min.js

<script src='https://cdn.jsdelivr.net/npm/butterfly-friend@latest/dist/friend.min.js'></script>
<script src="https://cdn.jsdelivr.net/gh/zykjofficial/zykjofficial.github.io@master/js/screen_shot.js"></script>
<script>
  var obj = {
    el:"#friend1",
    owner:"zykjofficial",
    repo:"friends",
    direction_sort:"asc",
    sort_container:["乐特专属","大佬们"],
    labelDescr:{
        "乐特专属":"<span style='color:red;'>这是乐特大佬的博客哟！</span>",
        "嘉神专属":"<span style='color:red;'>这是康特全球后援会(QQ群：939534493)的群主！</span>",
        "大佬们":"大佬们的博客(不分前后、都是大佬)",
        "傻逼菜狗":"一位隐藏的大佬",
        "Butterfly主题":"主题官网: <a link='https://butterfly.js.org'>https://butterfly.js.org</a> ",
    }
  };
  document.querySelector('.flink').insertAdjacentHTML('afterbegin', "<div id='friend1'></div>")
  new Friend(obj)
  getFriendsScreenShot({
    user: "zykjofficial-actions", // github用户名
    repo: "screen_shot", // github仓库名
  })
</script>

screen_shot.js 源码

let getFriendsScreenShot = function (options) {
    let user = options.user // github用户名
    let repo = options.repo // github仓库名
    let branch = options.branch ? options.branch : "gh-pages" // github分支
    let suffix = options.suffix ? options.suffix : "jpg" // 文件后缀
    let lazyImg = options.lazyImg ? options.lazyImg : "https://cdn.jsdelivr.net/gh/zykjofficial/zykjofficial.github.io@master/img/loading.gif" // 懒加载图片
    let duration = options.duration ? options.duration : 5000 // 持续时间
    let oldLength = document.querySelectorAll(".flink-list-item").length
    window.onload = function () {
        let links = document.querySelectorAll(".flink-list-item")
        let screen_shot = document.createElement("div")
        screen_shot.setAttribute("class", "screen-shot")
        screen_shot.innerHTML = `<img src=${lazyImg} alt="ScreenShot">`
        screen_shot.style.display = "none"
        for (let i = 0; i < links.length; i++) {
            links[i].onmouseover = function () {
                screen_shot.style.cssText = `top:${this.offsetTop + this.clientHeight + 5}px;left:${this.offsetLeft + this.clientWidth / 2}px;max-width:200px;position:absolute;z-index:99;width:100%;box-shadow:0 0 20px -5px rgba(158,158,158,.2);border-radius:3px;margin:0;padding:0;`
                let img = new Image()
                img.src = `https://cdn.jsdelivr.net/gh/${user}/${repo}@${branch}/${this.childnet[0].href.replace(/(http|https):\/\//ig, "").replace(/^(\s|\/)+|(\s|\/)+$/g, '').replace("/",".")}.${suffix}`
                img.onload = function () {
                    screen_shot.childnet[0].src = img.src
                }
            }
            links[i].onmouseout = function () {
                screen_shot.style.cssText = "display:none;"
                screen_shot.childnet[0].src = lazyImg
            }
        }
        let result = oldLength != document.querySelectorAll(".flink-list-item").length ? true : false
        if (GLOBAL_CONFIG.Snackbar) {
            var snackbarBg = document.documentElement.getAttribute('data-theme') === 'light' ? GLOBAL_CONFIG.Snackbar.bgLight : GLOBAL_CONFIG.Snackbar.bgDark
            var snackbarPos = GLOBAL_CONFIG.Snackbar.position
            Snackbar.show({
                text: result ? "友链截图加载完毕" : "友链截图加载失败",
                backgroundColor: snackbarBg,
                duration: duration,
                pos: snackbarPos,
                actionText: result ? "" : "刷新",
                actionTextColor: '#fff',
                onActionClick: result ? null : function (e) { location.reload(true) }
            })
        } else {
            var showBg = document.documentElement.getAttribute('data-theme') === 'light' ? '#49b1f5' : '#1f1f1f'
            var cssText = `top: 0; background: ${showBg};`
            document.getElementById('app-refresh').style.cssText = cssText
        }
        if(result) document.querySelector("body").appendChild(screen_shot)
    }
}