jekyll-theme-WuK

jekyll-theme-WuK

A content-first, sliding sidebar theme for Jekyll.

Quick Start

感谢使用我的博客主题,下面跟随一些简单操作快速生成你的站点/文档/展示页面吧无需命令行

在 Github 上阅读此页

第一步

点这个链接https://github.com/wu-kan/wu-kan.github.io/fork,把示例站点 fork 到你的仓库。注意,fork 的是示例站点,fork 主题仓库是不完整的!

第二步

在你 Fork 之后的仓库里,选择 Setting,将仓库名改成your-name.github.io

例如这里我用来示例的 GitHub 小号是 @Mizuno-Ai ,改的名字就是Mizuno-Ai.github.io

第三步

把 Setting 拉到下面找到 Github Pages 相关选项,将 Source 从改成 None 改到 master branch,再将 Custom domain 改成你的网址。

稍等一下,应该会提示你的博客地址可以访问了!你已经成功大半啦~

第四步

回到仓库根目录下,自行配置_config.yml,能看懂多少就改多少。大部分配置项我都加了注释。

要注意 yaml 格式中缩进是很重要的,不要破坏本来的缩进。

第五步

回到仓库根目录下,点开/_posts/文件夹,这个目录存放博客文章。点 Create new file 就可以写你自己的博客了。这些文章使用的格式是 Markdown,这是一种非常简单易用的有格式文本标记语言,文件后缀名是 md

文件命名方式需要是日期-标题.md;文件内容前最好要有一个title: 标题的 yaml 头,以防止显示错乱。

写好之后和改配置的操作类似,点 Commit 提交。现在再访问你的博客,可以发现你的博文已经出现在归档页的最上面了!Enjoy~

欢迎

进一步定制

以上所有操作均可直接在 github 网页上进行。如果你在本地运行博客的测试,或是对博客进行更高级别的定制,推荐先阅读以下几篇博文:

统一中文文案、排版的相关用法,降低团队成员之间的沟通成本,增强网站气质,推荐阅读:

Demo

文件结构

我的主题主要实现了如下几种渲染页面的样式供选择。

layout: default

基于poole/lanyon的页面,提供一个侧边栏和可随侧边栏移动的 warp。

layout: page

基于layout: default,提供了一个标题栏.masthead和文本框的.content

layout: comments

基于layout: page的留言页,留言插件使用了Valine

示例:https://wu-kan.cn/comments/

layout: post

基于layout: comments的博文页,为每篇博文增加描述信息。

示例:基于 Jekyll 搭建个人博客

layout: merger

基于 merger 的打赏页。

示例:https://wu-kan.cn/merger/

layout: home

v3.1.0版本开始,layout: home被我重写,基于hakimel/reveal.js实现了一个简洁的展示页面,既可以作为博客的封面,也可以用作 presentation!

示例:我的数图期末展示页

向你的 markdown 文件中插入水平页面分隔符和垂直页面分隔符(可自定义),即可快速开始使用啦!可以以本篇文档作为使用示例。

推荐的分隔符是

,这样可以和vscode-markdown-preview-enhanced的标记兼容,方便本地预览。

如果你希望使用它来渲染主页之外的页面,可以在你的 markdown 的 yaml 头中设置layout: home即可!当然,如果你不希望使用它来渲染主页,你也可以将主页的 layout 设置成其他的。

想针对特定页面默认开启侧边栏?在 yaml 头中设置jekyll-theme-WuK: default: sidebar: open: true即可!

想针对特定页面隐藏侧边栏?在 yaml 头中设置jekyll-theme-WuK: default: sidebar: disable: true即可!会覆盖sidebar: open的设置。

这是一个仍在开发的特性(主要是找不到美观精致的展示主题),如果有建议/需求欢迎 issue!

更多的功能,请尽情探索hakimel/reveal.js例如,按 Esc 可以生成一个 ppt 大纲

初心

我曾做什么?

我正做什么?

我想做什么?

我该做什么?

章北海感到父亲的灵魂从冥冥中降落到飞船上,与他融为一体,他按动了操作界面上那个最后的按钮,心中默念出那个他用尽一生的努力所追求的指令:

“‘自然选择’,前进四!”

目标是打造一个尽可能简洁,而可定制内容又尽可能丰富的博客。如果有更好的建议,欢迎给我提 Issue!

声明

除特别声明或转载外,所有博文采用署名-相同方式共享 4.0 国际协议进行许可。

博客基于MIT License开源于GitHub

致谢

托管于Github Pages,感谢。

博客引擎来自于jekyll/jekyll,感谢。

CDN 加速服务来自于https://cdn.jsdelivr.net/https://loli.net,感谢。

博客主题基于poole/lanyon,感谢。

图标库来自于fontawesome-free,感谢。

展示页基于hakimel/reveal.js,感谢。

捐赠页来自hifocus/merger,感谢。

页面压缩来自于penibelst/jekyll-compress-html,感谢。

评论系统来自于utterance/utterances,感谢。

页面统计来自于不蒜子,感谢。

博客搜索插件来自于christian-fei/Simple-Jekyll-Search,感谢。

博文目录插件来自于allejo/jekyll-toc,感谢。

代码高亮及插件来自于PrismJS,感谢。

Live2D 前端插件来自于Dreamer-Paul/Pio,感谢。

Live2D Model 来自于imuncle/live2dxiaoski/live2d_models_collection,感谢。

头像、壁纸来自于https://www.pixiv.net/artworks/71574257https://www.pixiv.net/artworks/71932901https://www.pixiv.net/artworks/74559485,感谢(侵权必删)。

头像翻转效果受启发自leopardpan/leopardpan.github.io,感谢。

历程

2024-01-21 v4.3.0

  • 增加页面加载器 loader
  • 增加 prepend_to_sidebar,修复 side-bar 加载变色问题

2024-01-21 v4.2.1

2022-01-26 v4.2.0

  • layout: page 页面的插件支持智能引入

2021-06-07 v4.1.0

  • 对主题进行精简,去掉
    • layout: archive
    • layout: tags
    • layout: page404
  • 配合 jekyll-redirect-from 模板,增加
    • layout: redirect
  • 使用utterances代替 valine

2021-06-03 v4.0.5

  • 一些页面选项的增强
    • 可直接从前一个版本升级

2021-05-23 v4.0.4

  • 后端实现精简,去掉主页部分

2021-01-10 v4.0.3

  • document 样式更新,渲染成类似于 $\LaTeX$ 的样式

2020-09-15 v4.0.2

  • 侧边栏增加 minivaline-counter 的可选功能
    • 可用于替代不蒜子计数器,修复两个计数器数量不一致的问题

2020-07-23 v4.0.1

  • 修复使用 rouge 并开启代码行号时使用jekyll-compress-html导致渲染错误的问题
  • 修复 search.json 失效的问题
  • default、home 增加 append 配置项
  • 打包发布

2020-06-21 v4.0.0

  • 将所有主题配置变量移动到 front-matter-defaults,从而使得所有页面可以自定义配置
  • 标签页、归档页增加一个目录(可选)
  • 插件位置调整到页面底部,提高页面加载速度

2020-05-29 v3.2.1

2020-05-21 v3.2.0

  • 修复 reveal.js 自动更新到 4.0 版本后渲染错误的问题!
  • document 页回归,现在可以生成 github readme 风格的可打印文档
  • 修复当博文没有标签时仍然显示标签图标的 bug
  • 配置项中的 alert 命名不规范,全部换成 append/prepend
  • 博客目录插件更换成 allejo/jekyll-toc,纯 Liquid !
    • 下一步将按同样思路优化 katex、mermaid、prism 三个插件的渲染速度

2020-04-28 v3.1.5

  • 修复博文字数统计忽略中文的问题
  • 修复 valine 阅读量统计失效的问题

2020-04-20 v3.1.4

  • 修复归档页年份博文数量统计错误的问题

2020-04-20 v3.1.3

  • 归档页、标签页增加一个饼状统计图
    • 好丑啊,可以关掉
  • 归档页现在按照年份归档

2020-04-12 v3.1.2

  • poole/lanyon 更新至 v1.1.0
  • Live2D 增加变换主题按钮
  • page 中用到的变量移动到jekyll-theme-WuK命名空间下

2020-03-28 v3.1.1

  • 删去壁纸,加快本地测试速度
  • 修复 layout: home 中代码块渲染可能存在的一些问题

2020-02-29 v3.1.0

  • 使用 bundle 管理版本和运行依赖
  • 使用 Remote_theme 将博客主题和博文分离
  • 部署 gitlab 镜像站,解决百度爬虫爬不到的问题
  • 基于hakimel/reveal.js重写layout: home
  • 更换 live2d 插件为Dreamer-Paul/Pio
  • 更换 live2d 模型
  • 定制 live2d 提示语
  • css 样式更新
    • 彩虹滚动条
    • 页面加载动画
    • 更换竖屏下壁纸

这么大的更新感觉版本号改成“4.0.0”也不为过嘛。

不过实际上这个版本保持了和前一个版本的兼容,因此是“3.1.0”。

2020-02-14 v3.0.0

  • 插件引入方式完全重构,现在直接嵌入 html 即可
  • 更换 live2d 插件为kooritea/live2d-helper,从而支持 live2d 定制
    • 看板娘隐藏按钮
  • 去除 jQuery
  • 去除 categories 标签,使用 tags 代替
  • 博客结构调整,把/public目录迁移到 jekyll 默认的/assets
  • merger 打赏页
  • 侧边栏样式调整,更加简洁
  • 为竖屏显示增加壁纸
  • 全局搜索
  • $\KaTeX$ 行间公式

2020.01.31 v2.4.1

  • 赞赏按钮样式修复
  • 使用https://loli.net加速 gravatar,感谢~
  • 网站字体更换为等宽字体+微软正黑体
  • live2d 移动到页面右侧
  • 更换爱酱壁纸

2019.11.11 v2.4.0

  • 修复sidebar-overlay失效的 Bug
  • 修复赞助按钮点两次才出现的 Bug
  • 修复 mermaid 不显示的 Bug
  • 去掉正文部分的白色半透明背景
  • 动态背景增加 nest 粒子动画(花里胡哨,默认关闭
  • Ribbon 动态背景默认关闭,可在配置文件中去掉注释打开(花 里 胡 哨
  • 博文显示信息增加 tag
  • 变迁页面增加 tag、categories 图标及对应分类文章数量
  • 页面显示适应宽屏显示器
  • layout 增加
    • index
    • tag
    • page404

2019-08-30 v2.3.0

  • 更换 cdn 为jsDelivr
  • 升级 fontaswsomev4.7.0 至 fontawesome-freev5.10.2,支持的图标数量由 675 增加至 1535
  • 所有脚本和插件 JSLoader 化,增加移植性和访问速度
  • 界面调整
    • 正文部分增加背景,从而减少动态 ribbon 背景影响的阅读体验
    • sidebar 微调
  • layout 删除 document 页

2019-07-06 v2.2.1

  • prismjs 使用UNPKG加速
  • 删去 layout 中的 404 页(因为只需要引入 js 脚本)

2019-06-28 v2.2.0

  • 博客结构微调
  • 将大部分博客用到的 jscdn 换成 unpkg.com,感谢其提供的加速服务~
  • 留言板加入友链

2019-05-03 v2.1.4

  • valine 更新
    • 现在支持记录访问者 IP
    • 每次重新拉取评论者头像

2019-04-29 v2.1.3

  • 页面样式微调,将 masthead 调矮,将标题字号改小

2019-03-20 v2.1.2

  • 修复 sidebar 展开时回到顶部的问题

2019-03-18 v2.1.1

  • 一些界面上的小调整

2019-03-01 v2.1.0

  • 调整某些插件
  • layout 新增 document 页,一个只开启$\KaTeX$而不引入任何其他样式的页面,主要是方便自己生成可打印的 ICPC 模板和一些课程报告
  • layout 新增 404 页,可选择开启腾讯公益
  • mermaid 支持 markdown 扩展了

2019-02-24 v2.0.1

  • sidebar 的触发按钮样式换成了 bars,原来的样式更像是菜单
  • 一点页面上的小调整

2019-02-23 v2.0.0

  • 重构完成
  • 正式开源

2019-02-19

  • 模块化·初步
  • 博客搜索实现

2019-02-01

2019-01-31

  • mathjax 换 katex
  • post 访问量统计

2019-01-24

  • 代码高亮
  • 选中代码按钮
  • 代码语言按钮

2019-01-23

  • 加入文章目录到 SideBar

2019-01-22

  • 加入 Ribbon 动态背景

2019-01-21

  • 加入 valine 评论系统,留言页实现

2019-01-20

  • 加入归档页

2019-01-19

  • 加入标签页

2019-01-18

  • 开始用 Jekyll 重构整个博客

折腾吧,折腾是才最好玩的。

2019-01-13

  • 更换 Next.Muse 主题模板
  • 少量修改页面自定义样式布局,主要是 sidebar
  • 将网易云音乐 iframe 移动到 description,感觉挺有意思的

2019-01-12

  • 将 NexT 版本更新至 v6.7.0

2018-12-23

  • 页面字体修改
  • 网易云音乐 iframe 加入 SideBar

2018-12-16

  • 引入 mermaid 支持
  • 修复部分 Latex 渲染的 Bug

2018-11-24

  • 将 NexT 版本更新至 v6.5.0
  • 用 Valine 更换失效的 Gitment 评论系统
  • 加入 Leancloud 和 busuanzi 页面统计

2018-11-20

  • 谷歌,百度搜索页面提交

2018-11-18

  • 全局透明化
  • 动态背景
  • 页面加载动画
  • Latex 支持

2018-11-16

  • 主题由默认的 Landspace 换至 NexT v5.1.4
  • 使用 Next.Pisces 主题模板
  • 开始对网页进行自定义样式布局
  • 尝试加入 Gitment,但初始化总是不成功

2018-11-15

  • 在 Github 上成功部署博客
  • 成功迁移原 CSDN 博客上的所有文章
  • live2d