Butterfly 安装文档(二) 主题页面
📖 本教程更新于 2022 年 10 月 21 日,教程的内容针对最新稳定版而更新(如果你是旧版,教程会有些出入,请留意)
🦋 Butterfly 已经更新到 4.5.0
📚 文档目录
🚀 快速开始📑 主题页面🛠 主题配置-1⚔️ 主题配置-2❓ 主题问答⚡️ 进阶教程自定义代码配色添加全局吸底 Aplayer 教程自定义侧边栏标签外挂 (Tag Plugins)内置标签外挂Markdown Style testCode Highlight Style test个性化配置
你可以通过右下角的 简 按钮切换为简体显示
Front-matter
Front-matter 是 markdown 文件最上方以 ---
分隔的区域,用于指定个别档案的变数。
- Page Front-matter 用于
页面
配置 - Post Front-matter 用于
文章页
配置
如果标注可选
的参数,可根据自己需要添加,不用全部都写在markdown里
Page Front-matter
1 | --- |
写法 | 解释 |
---|---|
title | 【必需】页面标题 |
date | 【必需】页面创建日期 |
type | 【必需】标签、分类和友情链接三个页面需要配置 |
updated | 【可选】页面更新日期 |
description | 【可选】页面描述 |
keywords | 【可选】页面关键字 |
comments | 【可选】显示页面评论模块(默认 true) |
top_img | 【可选】页面顶部图片 |
mathjax | 【可选】显示mathjax(当设置mathjax的per_page: false时,才需要配置,默认 false) |
katex | 【可选】显示katex(当设置katex的per_page: false时,才需要配置,默认 false) |
aside | 【可选】显示侧边栏 (默认 true) |
aplayer | 【可选】在需要的页面加载aplayer的js和css,请参考文章下面的音乐 配置 |
highlight_shrink | 【可选】配置代码框是否展开(true/false)(默认为设置中highlight_shrink的配置) |
Post Front-matter
1 | --- |
写法 | 解释 |
---|---|
title | 【必需】文章标题 |
date | 【必需】文章创建日期 |
updated | 【可选】文章更新日期 |
tags | 【可选】文章标签 |
categories | 【可选】文章分类 |
keywords | 【可选】文章关键字 |
description | 【可选】文章描述 |
top_img | 【可选】文章顶部图片 |
cover | 【可选】文章缩略图(如果没有设置top_img,文章页顶部将显示缩略图,可设为false/图片地址/留空) |
comments | 【可选】显示文章评论模块(默认 true) |
toc | 【可选】显示文章TOC(默认为设置中toc的enable配置) |
toc_number | 【可选】显示toc_number(默认为设置中toc的number配置) |
toc_style_simple | 【可选】显示 toc 简洁模式 |
copyright | 【可选】显示文章版权模块(默认为设置中post_copyright的enable配置) |
copyright_author | 【可选】文章版权模块的文章作者 |
copyright_author_href | 【可选】文章版权模块的文章作者 链接 |
copyright_url | 【可选】文章版权模块的文章连结 链接 |
copyright_info | 【可选】文章版权模块的版权声明 文字 |
mathjax | 【可选】显示mathjax(当设置mathjax的per_page: false时,才需要配置,默认 false) |
katex | 【可选】显示katex(当设置katex的per_page: false时,才需要配置,默认 false) |
aplayer | 【可选】在需要的页面加载aplayer的js和css,请参考文章下面的音乐 配置 |
highlight_shrink | 【可选】配置代码框是否展开(true/false)(默认为设置中highlight_shrink的配置) |
aside | 【可选】显示侧边栏 (默认 true) |
标签页
前往你的 Hexo 博客的根目录
输入
hexo new page tags
你会找到
source/tags/index.md
这个文件修改这个文件:
记得添加
type: "tags"
1 | --- |
分类页
前往你的 Hexo 博客的根目录
输入
hexo new page categories
你会找到
source/categories/index.md
这个文件修改这个文件:
记得添加
type: "categories"
1 | --- |
友情链接
为你的博客创建一个友情链接!
创建友情链接页面
前往你的 Hexo 博客的根目录
输入
hexo new page link
你会找到
source/link/index.md
这个文件修改这个文件:
记得添加
type: "link"
1 | --- |
友情链接添加
在Hexo博客目录中的source/_data
(如果没有 _data 文件夹,请自行创建),创建一个文件link.yml
1 | - class_name: 友情链接 |
class_name
和 class_desc
支持 html 格式书写,如不需要,也可以留空。
从 4.0.0
开始,支持从远程加载友情链接,远程拉取只支持 json
。
注意: 选择远程加载后,本地生成的方法会无效。
在 source/link/index.md
这个文件的 front-matter 添加远程链接
1 | flink_url: xxxxx |
Json 的格式
1 | [ |
友情链接界面设置
由 2.2.0 起,友情链接界面可以由用户自己自定义,只需要在友情链接的md档设置就行,以普通的Markdown格式书写。
图库
图库页面只是普通的页面,你只需要hexo n page xxxxx
创建你的页面就行
然后使用标签外挂 galleryGroup,具体用法请查看对应的内容。
1 | <div class="gallery-group-main"> |
子页面
子页面也是普通的页面,你只需要hexo n page xxxxx
创建你的页面就行
然后使用标签外挂 gallery,具体用法请查看对应的内容。
1 | {% gallery %} |
如果你想要使用 /photo/ohmygirl
这样的链接显示你的图片内容
你可以把创建好的 ohmygirl
整个文件夹移到 photo
文件夹里去
404页面
主题内置了一个简单的404页面,可在设置中开启
本地预览时,访问出错的网站是不会跳到404页面的。
如需本地预览,请访问http://localhost:4000/404.html
1 | # A simple 404 page |