leanote-theme-chirpy

leanote-theme-chirpy

Chirpy Jekyll Theme 在 Leanote 上的移植

Chirpy Leanote Theme

这是一款简约而强大、采用响应式设计的 Leanote 主题,适合展示专业写作内容。

本主题是 Chirpy Jekyll Theme 的移植。通过 issue #83 得知了这款主题,可以说是一见钟情了,马上动手移植,大体框架算是移植完成了。

线上体验 →

功能一览

  • 深色模式
  • 可选的 Disqus 评论,Valine 评论,GitTalk 评论
  • 语法高亮,一键复制
  • 数学表达式
  • 文章目录、二级目录
  • 可选的 Leancloud 文章阅读量统计、Leanote 自带的阅读量统计
  • Mermaid、ChartJs 图表
  • Google 分析
  • 博文置顶
  • jsdelivr 自定义CDN地址

安装

这个分支对应我修改过的 Leanote。如果只想使用官方发布的Leanote服务端,请切换到 leanote_2.6 分支。

本分支的安装流程如下:

  1. 参考 Leanote Wiki 安装我修改过的 Leanote 服务端
  2. Releases页面 下载 1.1.x 版本的压缩包,或者下载仓库 master 分支的压缩包,在 Leanote 主题配置页面导入即可。

使用

根据个人需要去修改 theme.json 的内容,都有注释介绍用法,其中评论和文章阅读统计功能默认是关闭的,想打开需要设置 CommentTypeReadNumType 字段。

使用 Gitalk 评论

  1. 首先需要一个已存在或创建一个新的github存储库用来存放 Issues
  2. 然后还需要一个 GitHub Application,创建一个 GitHub ApplicationHomepage URLAuthorization callback URL 填写博客地址,其他可以随意填写。
  3. 找到 Client IDClient secrets 等参数填入 theme.json 中:
"Gitalk": {
  "clientID": "", // // GitHub Application Client ID
  "clientSecret": "",
  "repo": "", // 存放评论的仓库
  "owner": "", // 仓库的创建者
  "admin": [""]  // 如果仓库有多个人可以操作,在这里以数组形式写出
},

注:json 配置块不能含有注释信息

更具体可参考 gitalk install

Gitalk 需要手动初始化所有文章的评论:用自己的 Github 账号登录 Gitalk 评论后,需要手动点开一遍所有的文章。以后看能否写一个初始化的脚本。

使用 Valine 评论

如果想使用 Valine 评论, 需要在 Leacloud 创建应用,获取 appIdappId 填入 theme.json 中:

"Valine": {
  "appId": "",
  "appKey": ""
},

更具体可参考 Valine 快速开始

Leancloud 文章阅读量统计

如果不想用 Leanote 自带的文章阅读量统计,可以切换 Leancloud 版本,仍然要在 Leacloud 创建应用。

Todo

  1. Chartjs功能转到主题那边实现并适配夜间模式
  2. MathJax 升级到 3.0
  3. 支持 Valine,一款基于LeanCloud的快速、简洁且高效的无后端评论系统
  4. 支持 GitTalk
  5. 分页列出所有的页码
  6. [] 本地化外观语言
  7. [] 自动推荐相关文章
  8. [] Gitalk 初始化脚本

Bug 或者不足

  1. Emoji container 适配夜间模式
  2. MathJax 升级到3.0后,不使用原来的代码,公式中的换行(双斜杠)会被转义成单斜杠,暂代方案是使用(\\\)或者 \newlineh 或者 \displaylines。目前是参考了 Hexo下mathjax的转义问题使Marked.js与MathJax共存, 取消了对 \\\{} 的转义,公式能够正常换行,但有没有别的 Bug 还有待观察 换成 markdown-it 渲染没有这些问题
  3. post 的阅读次数没有增加:可选使用 Leanote 自带的阅读计数或者用 LeanCloud 的阅读计数
  4. Leanote 的分类页面的逻辑和 Jekyll、Hexo 等的不一样,Leanote 服务端已修改相应逻辑
  5. 将博客设置里的排序方式改成按照创建时间排序后,影响的只有主页的排序,归档页面仍然是按照 PublicTime 排序的。已修复。

反馈

使用过程中,如果遇到问题,请给作者提 Issue

赞助

如果您喜欢此款主题或者它对您有帮助,请考虑打赏作者,您的支持将会极大地鼓励作者,并帮助作者更好地维护项目!

许可证书

本项目开源,基于 MIT 许可。

jekyll logo

Want a Jekyll website built?

Hire a Jekyll developer