A Slideshow plugin for theme-butterfly based on swiper
npm install hexo-butterfly-swiper给hexo-theme-butterfly添加 首页轮播图
1. 安装插件,在博客根目录[Blogroot]下打开终端,运行以下指令:
``bash`
npm install hexo-butterfly-swiper --save
2. 添加配置信息,以下为写法示例
在站点配置文件_config.yml或者主题配置文件_config.butterfly.yml中添加
`yaml`
# hexo-butterfly-swiper
# see https://akilar.top/posts/8e1264d1/
swiper:
enable: true # 开关
priority: 5 #过滤器优先权
enable_page: / # 应用页面
exclude: #屏蔽页面
# - /posts/
# - /about/
timemode: date #date/updated
layout: # 挂载容器类型
type: id
name: recent-posts
index: 0
error_img: /img/default.png #封面图片加载失败的默认封面
insertposition: afterbegin
default_descr: 再怎么看我也不知道怎么描述它的啦!
swiper_css: https://unpkg.zhimg.com/hexo-butterfly-swiper/lib/swiper.min.css #swiper css依赖
swiper_js: https://unpkg.zhimg.com/hexo-butterfly-swiper/lib/swiper.min.js #swiper js依赖
custom_css: https://unpkg.zhimg.com/hexo-butterfly-swiper/lib/swiperstyle.css # 适配主题样式补丁
custom_js: https://unpkg.zhimg.com/hexo-butterfly-swiper/lib/swiper_init.js # swiper初始化方法
3. 参数释义
|参数|备选值/类型|释义|
|:--|:--|:--|
|priority|number|【可选】过滤器优先级,数值越小,执行越早,默认为10,选填|
|enable|true/false|【必选】控制开关|
|enable_page|path/all|【可选】填写想要应用的页面的相对路径(即路由地址),如根目录就填'/',分类页面就填'/categories/'。若要应用于所有页面,就填'all',默认为all|
|exclude|path|【可选】填写想要屏蔽的页面,可以多个。仅当enable_page为'all'时生效。写法见示例。原理是将屏蔽项的内容逐个放到当前路径去匹配,若当前路径包含任一屏蔽项,则不会挂载。|
|timemode|date/updated|【可选】时间显示,date为显示创建日期,updated为显示更新日期,默认为date|
|layout.type|id/class|【可选】挂载容器类型,填写id或class,不填则默认为id|
|layout.name|text|【必选】挂载容器名称|
|layout.index|0和正整数|【可选】前提是layout.type为class,因为同一页面可能有多个class,此项用来确认究竟排在第几个顺位|
|error_img|url|封面图片加载失败时的替换图片|
|insertposition|text|'beforebegin':元素自身的前面。'afterbegin':插入元素内部的第一个子节点之前。'beforeend':插入元素内部的最后一个子节点之后。'afterend':插入元素自身的后面。|
|default_descr|text|【可选】默认文章描述|
|swiper_css|url|【可选】自定义的swiper依赖项css链接|
|swiper_js|url|【可选】自定义的swiper依赖项加js链接|
|custom_css|url|【可选】适配主题样式补丁|
|custom_js|url|【可选】swiper初始化方法|
4. 使用方法
在文章的front_matter中添加swiper_index配置项即可。`
markdown``
---
title: 文章标题
date: 创建日期
updated: 更新日期
cover: 文章封面
description: 文章描述
swiper_index: 1 #置顶轮播图顺序,需填非负整数,数字越大越靠前
---