Yume Syutoi

Syutoi

A place to write, read and think.

归档

Hexo主题Syutoi & multi-markdown-it渲染器使用说明

文章目录

历史文档:本页保留上游主题的说明与示例,部分私有语法现仅显示为原文,不代表当前功能。当前写法与替代方案请参阅 Syutoi 写作与迁移示例

跳票N久终于更新的简单的使用说明

已经支持hexo 5。

因博主被学业和工作掏空,本项目已停滞更新大半年,问题也无法及时回复大家,这个悲惨状态可能还要持续半年的样子。

有很多热心小伙伴在评论区或者项目issue帮忙回答问题,非常非常感谢!

本项目是完全开源的,也有做一些example示例,大家可以随便拿随便改。 但是很抱歉,博主我暂时不能提供更多的支持,这个写的乱七八糟的文档,暂时也没有时间把它写得更专业一些。 非常对不住大家!

iconfont的添加申请,我看到留言后会尽快加上,希望各位小伙伴能看到。

当前版本更新至 0.2.5,更新记录点此

:rocket:快速开始 - :love_letter:依赖插件 - :pushpin:基本配置 - :rainbow:界面显示 - :unicorn:特殊功能

设计缘由

前几年在Bear和Evernote上整理了大量笔记,非常喜欢Bear默认的markdown渲染样式。 后来因为换了安卓手机,用不了Bear,四处搜寻替代品,没有满意的。 然后阴差阳错知道了Hexo,又得知Github也可以免费建私有仓库了,故再次转移阵地到了自建博客,并部署在Github Pages。

因为这个博客是用来记笔记的,故起名书架。 对应的主题即Theme.Syutoi,可以说是为了笔记阅读而生的主题。 样式严重参考Bear,部分代码严重参考NexT

Hexo的默认及常用渲染器均使用highlight.js进行代码高亮,而我喜欢Prism.js,故重写了一个渲染器配合主题食用。 渲染器取名multi,因为集成了很多很多很多markdown-it插件,以及压缩静态文件的功能。 (最新版的默认渲染器也支持Prism.js了,可喜可贺,但不想用,哈哈哈哈哈哈哈

墙内Github Pages访问速度时而感人,所以用了jsDelivr加速,主要是因为它可以按需合并依赖文件。

快速安装

bash
# cd your-blog
git clone https://github.com/syutoi/hexo-theme-syutoi.git ./themes/syutoi

打开主题目录,内有example文件夹,提供了配置文件的demo供参考。

安装依赖插件

在应用主题之前,必须至少安装 hexo-renderer-multi-markdown-it 渲染插件 和 hexo-autoprefixer

插件安装与配置教程戳此

应用主题

修改站点配置

修改站点配置文件<root>/_config.yml,把主题改为 syutoi

yml
theme: syutoi

修改主题配置

主题配置的所有参数在<root>/themes/syutoi/_config.yml文件中。

为了方便主题升级,请在根目录新建一个yml文件,命名为_config.syutoi.yml。 也就是说,所有主题的自定义配置均保存于<root>/_config.syutoi.yml文件。

主题的基础配置可以参考这里 界面显示相关的配置参考这里

更新记录

标签含义: ❗ 需要手动操作的更新信息 ⚠️ 需要注意的更新信息 🔧 已修复的问题 ⌛ TODO

0.2.4 👉 0.2.5

💡 避免直接修改主题文件,添加各种自定义:

🔧 修复一些BUG

0.2.3 👉 0.2.4

⚠️ 评论功能更新

  • MiniValine魔改版更新至beta10,修改过主题默认_config.yml的同学,记得更新末尾的vendors到最新哦
  • ❗ 评论相关的配置有更新,配置戳此
    • 主要增加的Tag配置,现在可以各种自定义啦

⚠️ 配置新增

⚠️ 背景音乐功能增强,配置戳此

  • 可以添加多个播放列表
  • 加了一些控制按钮

⚠️ 增加media标签,在文章中插入音频和视频播放列表,方法戳此 ⌛ 视频播放器有待增强(显示分段标签,字幕)

🔧 随机图库支持非渣浪图床的任意图片 🔧 还有许多小BUG

0.2.2 👉 0.2.3

❗ 增加主题文件外自定义语言包的功能,配置戳此 🔧 提高低版本浏览器兼容性

0.2.1 👉 0.2.2

⚠️ 弃用mediumzoom,改成fancybox配置戳此 💡 增加语言包:繁体中文日语 💡 quiz功能优化,根据语言显示题型标签 🔧 修复评论功能中反复初始化leancloud-storage 🔧 修复audio: false时不能隐藏播放按钮、停止播放

0.2 👉 0.2.1

⚠️ 配置文件添加 loader 参数,配置戳此 💡 二级list区别显示 🔧 修复浏览位置定位BUG 🔧 修复firework动画延迟 🔧 优化评论功能

0.1.9 👉 0.2

⚠️ 评论功能大改

  • 弃用不开源的Valine,改用MiniValine,并且进行了魔改,项目戳此 主要是大量压缩了代码,弃用一些花里胡哨的功能,又加了一些别的花里胡哨的功能。
  • 为防止泄露用户邮箱、IP等隐私信息,弃用QQ号获取昵称及头像。 ❗ 同时需要手动进行一些迁移,具体步骤戳此
  • ❗ 评论相关的配置亦有更新,配置戳此

⚠️ 增加单击页面烟花效果,配置戳此 💡 弃用Velocity,改用anime.js,方便未来添加更多!!花里胡哨的!!功能!!严重拖慢页面滑行速度!! 🔧 新增多枚icon,包括豆瓣i-douban等 🔧 一些显示问题