[ ![halo-theme-joe2.0](https://cdn.jsdelivr.net/gh/qinhua/halo-theme-joe2.0@master/logo.png) ](https://github.com/qinhua/halo-theme-joe2.0) Joe 主题 Halo 移植版 [ ![Halo](https://img.shields.io/badge/Halo-1.4.11-p) ](https://halo.run) [ ![Release](https://img.shields.io/badge/FreeMarker-2.3.3-blue) ](https://github.com/qinhua/halo-theme-joe2.0) [ ![Release](https://img.shields.io/badge/Release-1.0.0-green) ](https://github.com/qinhua/halo-theme-joe2.0) [ ![License](https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-orange) ](https://halo.run) > `Joe2.0` 是 [Typecho Themes Joe](https://github.com/HaoOuBa/Joe) 主题的 Halo 版，由于 [社区](https://bbs.halo.run/) 之前有兄弟移植过，这次就叫 Joe2.0 吧，此次在原版主题上做了不少修改和适配，由原版的 php 模板调整为 freemarker，移除了平台无关的特性，同时增加了一些平台特定的配置，保持灵活性的同时最大限度的移植了原版功能，希望大家喜欢 ❤️ > 🌸 同时也要在此感谢原作者 [Joe](https://github.com/HaoOuBa)。 #### 👀 [预览主题](https://bbchin.com) **首页截图** 👇 ![screenshot](https://cdn.jsdelivr.net/gh/qinhua/halo-theme-joe2.0@master/source/img/dp/display.png) ## 🌈 主题安装 1. 复制主题仓库地址 `https://github.com/qinhua/halo-theme-joe2.0.git` 2. 进入博客后台管理 `外观-主题-安装-在线安装`，贴入仓库地址进行安装（建议直接使用最新版本）。如果在线安装失败，可以选择本地安装，到主题 [Release](https://github.com/qinhua/halo-theme-joe2.0/releases) 页面下载指定版本主题包，并以附件形式传上去； 3. 等待提示安装完成即可。 ### ⚠️ 注意： - 安装主题后请务必到 `后台管理 - 博客设置 - 高级选项` 中开启 `API服务` 并配置 `Access key` 为 `joe2.0`（注意：这里没必要一定是 joe2.0，可以配置为任意值），不然部分用到 `Content API` 的页面会请求失败，导致报错。 Tip：如果你后台管理中之前已经配置了其它的 `Access Key`（内容不是 `joe2.0`），那么需要你到本主题设置中的 `基本设置` 配置一下 `AccessKey`，和你后台中的一致即可（切记一致才行，且不要填写中文或特殊字符）。 - 主题升级后配置项变化较大时可能报错，导致页面渲染不出来。只需要进入当前主题的设置界面执行一下保存操作来更新旧的配置，然后再访问页面即可 - 有时主题已经更新成功了，但是页面还是加载的旧版本的文件，可能是由于 `主题激活状态不正常` 导致的。此时只需要先切换到其他主题再切回来即可。或者可以试着重启下后台试试。 - 刷新时记得打开控制台进行强刷，避免潜在缓存的影响，`CDN缓存` 也要及时清除。 ## 🔧 主题配置 > 此次修改对外暴露了大量的设置项，主要是为了最大程度方便用户对博客进行配置，详细设置项请参见主题根目录下的 `settings.yaml` 文件。 ![主题配置](https://cdn.jsdelivr.net/gh/qinhua/halo-theme-joe2.0@master/source/img/dp/shot_config.png) ## ⭐️ 主题功能 > 此次在功能上做了大量移植，在尽量不破坏原主题风格的情况下，加入了 `halo` 主题常见的配置项，也融入了一些自己的改进 🤔。 > 具体功能请在 `后台 -> 外观 -> 主题 -> 设置` 中进行配置，配置项已按不同场景分类，便于快速查找。 - 浅色/暗黑模式 - 三级导航 - 轮播图 - 自定义主题色 - 自定义字体 - 自定义背景图 - 自定义社交渠道 - 归档页定制(按年/月统计) - 日志页面定制 - 文章分享 - Toc 目录 - 代码高亮 + 行号 + 复制 + 折叠 - 文章和日志页点赞 + 评论 - 文章页 a 标签新页面打开 - 文章页复制加版权文字 - 留言页面 - 网易歌单(api 好像不稳定) - 博主可选头像框 - 博主等级展示 - 全局预载图自定义 - 缺省图片配置 - 每日一句 - 百度收录查询 + 主动推送 - 页面加载条 - 离屏提醒 - 网站公告 - 二维码模块 - 3D 标签云 - 看板娘 - 图库页面定制 - 自定义邮件模板 - 社交账号配置 - 二维码打赏 - 广告配置（侧边栏 + 文章页） - 自定义 JS/CSS - 自定义 favicon（支持视频、动图） - 站点运行时间 - 绿色模式（备案模式） - 灰色模式（RIP 模式） ## ✨ 改进点 - meta 标签优化 - ftl 模板格式化 - 导航栏优化 - 页脚调整 - 评论组件定制 - SEO 优化 - 样式优化 - 使用 Less - 根据主题模式调整了部分配色 - 优化 z-index 属性 - 滚动优化 - 代码优化 - 代码风格 - Eslint + Stylelint - JS 和 CSS 兼容性处理 - JS 使用 Babel 转换 - CSS 引入 autoprefixer - 移除部分页面 Grid 布局 - 页面性能优化 - 按需引入 - 图片懒加载 - DNS 预解析 - Gzip - 加载状态优化 - 加载条 - 预载图 - 错误图 - 空白状态 - 404 页面 - 去除无用配置 - 项目目录调整 - 简化目录 - 部分缺陷修复 - 解析主题配置项 ## 📈 状态 ![项目状态](https://repobeats.axiom.co/api/embed/8b5c2035344e9f8915682b868dfb13b33a6c0df9.svg "Repobeats analytics image") ## 📃 TODO > 目前仍有部分功能不完善，暂时没时间做，后面继续迭代。 - 博客总访问量 - 归档页统计图标 - 评论组件定制化（皮肤、参数简化、头像保存等） - 动态背景 - 国际化 - 全站 Pjax - 欢迎页面 - 视频播放插件 - 相册页优化 - 多种布局切换 - 展示动画优化 - 外链页面评论模块 - 自定义模板引擎 - 文章评论后可见 - 博客自动备份 ## 📚 开发指南 > 1、推荐使用 **VSCode** 开发，首先安装 **EasyLess** 插件来转换并压缩 less 文件，保存时会自动生成 `*.min.css` 文件，配置如下： ```js "less.compile": { "out": "./min/", "outExt": ".min.css", "compress": true, "sourceMap": false, "autoprefixer": "> 2%, last 2 versions, not ie 6-9" } ``` > 2、安装 **JS & CSS Minifier** 插件来转换并压缩 js 文件，保存时会自动生成 `*.min.js` 文件，配置如下： ```js "es6-css-minify.js": { "mangle": false, "compress": { "unused": true }, "output": { "quote_style": 0 }, "warnings": true }, // 保存时自动生成，no为手动，可点击编辑器底部 Minify 按钮生成 "es6-css-minify.minifyOnSave": "yes", "es6-css-minify.jsMinPath": "/source/js/min" ``` > 3、转换并压缩 `ES6+` 代码（前 2 步里的 js 没有经过 babel 编译，只可用于开发环境）： - 安装 `nodejs`; - 主题目录下执行 `npm i` 安装依赖; - 执行 `npm run build` 即可在相应目录生成可用于生产环境的 js 文件。 ## 🔍 代码提交规范项目默认配置了 `husky` 和 `lint-staged`，在 `commit` 阶段通过 `eslint` 和 `stylelint` 对代码进行自动格式化，然后打包，保证最终提交代码的规范性。 ## 🤔 注意点 > 主要是一些开发及使用过程中暴露出来的问题 #### 1、如何在浏览器中获取当前主题的配置信息？可以通过 `window.ThemeConfig` 直接获取。 #### 2、如何自定义导航条图标？ > 主题自身已经引入了部分 `iconfont` 图标，你可以直接用（[全在这里](https://bbchin.com/iconfont-joe2.0/)），如果想在这个基础上增加图标，可联系我加入该项目的图标组。`iconfont` 使用方式如下： ```html ``` **如果你要用自己的图标，请往下看：** - 首先通过 [iconfont](https://www.iconfont.cn/) 获取自己的图标链接，也可以用 [fontawesome](http://www.fontawesome.com.cn/) 的字体，注意要使用 `font-class` 类型，最后这种地址：//at.alicdn.com/t/font_2788564_1f1rnuqwnzj.css - 通过 `管理后台-外观-主题-Joe2.0-设置-自定义`，将图标地址贴入 `字体图标链接` 中并保存； - 通过 `管理后台-外观-菜单`，为相关菜单添加图标，也就是字体图标的类名，类似如下这种（字体名称 + 图标名称），记得保存； ```text iconfont icon-home ``` ![菜单图标配置](https://cdn.jsdelivr.net/gh/qinhua/halo-theme-joe2.0@master/source/img/dp/menu.jpg) - 最后，重新进入你的博客即可看到效果。 **tips: 目前主题菜单只支持字体图标，若要用图片请自行修改代码。** #### 3、如果一个菜单有子菜单，如何禁止父菜单跳转？ - 通过 `管理后台-外观-菜单`，设置相关菜单的地址为 `#`，保存即可，子菜单同理； - 最后，重新进入你的博客即可看到效果。 **tips: 为了适配和展示效果，不建议添加过多菜单。目前最多可展示 3 级。** #### 4、子菜单如何设置新页面打开？ - 通过 `管理后台-外观-菜单`，设置菜单的打开方式为 `新页面`，保存即可。 #### 5、如何配置邮件服务？ Halo 已经提供好了邮件服务，我们只需要配置相关参数即可。请参见 [《Halo 博客配置邮件通知服务》](https://www.yuque.com/docs/share/ccd93bac-6265-44a1-b2ec-c1e8fc101cdb) #### 6、如何配置留言页？目前主题中的留言页面是自定义页面，所以需要你进入 `后台管理-页面` ，点击 `新建页面` 添加留言页，然后把下面的模板复制进去并保存，最后进入 `外观-菜单` 添加刚才自定义的留言页，保存后刷新前台页面即可，其他自定义页面同理。 ```html 暂无留言，期待第一个脚印。 ``` #### 7、自己修改了主题中的 CSS 或 JS 后为什么还是用的以前的？目前主题默认使用 `CDN` 加载静态资源，要使用自己修改后的版本，需要到 `后台管理-外观-主题设置-其它` 中关闭 `使用CDN加载静态资源` 即可生效。但关闭后同时也失去了 `CDN` 加载的优势，如果你不想关闭，就需要自己单独修改文件引入处的链接。比如我修改了 `joe.index.min.css` 这个文件，那么就需要到 `template/module/link.ftl` 中找到引入它的地方： ```html ``` 把其中的 `${BASE_RES_URL}` 修改为主题自身路径 `${theme_base!}` 即可。 #### 8、如何通过元数据为文章详情页进行单独的功能配置？ - 很多时候，我们希望能够单独控制文章详情页的功能，如分享、打赏、复制、点赞、评论、目录等。主题目前已经为文章详情页暴露了常用的元数据配置，具体大家可以查看 `theme.yaml` 文件中的 `postMetaField` 字段。 - 如果我们想通过这些元数据来单独控制页面功能，可以到 `后台管理-文章-所有文章` 中找到要修改的文章，然后点击设置，再点击底部保存按钮旁的 `高级`，即可在弹框中对元数据进行配置，字段格式和主题配置是一致的，布尔值填 true 或 false，都是字符串形式。 ![文章详情页元数据配置](https://cdn.jsdelivr.net/gh/qinhua/halo-theme-joe2.0@master/source/img/dp/metas.png) #### 9、如何查看博客后台日志？有时博客访问不了，想查看后台日志，可以进入 `后台管理-系统-小工具-实时日志` 查看，生成环境可能需要先开启彩蛋（连续点击 `Halo Dashboard` 10 次触发），更多请参见 [Halo 隐藏功能](https://halo.run/archives/use-hidden-features)。 #### 10、Freemarker 相关小技巧主要是本人在开发主题过程中积累的一些 `Freemarker` 技能，希望能帮到需要的人。请参见 [FreeMarker 常用技巧](https://www.yuque.com/docs/share/f8a15e0c-3bf2-4c93-b2ef-e3bf2357d09c) ## 😈 小建议 #### 1、大家可以为站点资源开启防盗链 - 很简单，直接在 `nginx` 里配一下就可以，不过记得添加白名单（如 `logo` 和 `avatar`），配置如下： ```nginx # 资源防盗链（指定目录or指定文件类型） # location ~ .*\.(gif|jpg|jpeg|png|bmp|swf)$ { location /upload/ { access_log off; # 域名白名单，去掉则阻止所有非本站请求 valid_referers none blocked server_names *.bbchin.com 127.0.0.1 localhost ~\.google\. ~\.baidu\. ~\.qq\.; if ($invalid_referer) { rewrite ^/ https://cdn.jsdelivr.net/gh/qinhua/cdn_assets/img/robber.jpg; } proxy_pass http://127.0.0.1:8090; } ``` #### 2、可以使用 [webp_server_go](https://github.com/webp-sh/webp_server_go) 这个工具对全站图片进行 `webp` 化，提高加载速度，具体使用请参考 [如何无痛切换网站图片格式到 webp](https://bbchin.com/archives/towebp)。 ## 🏭 贡献如果你想帮助完善 `Joe2.0` 主题，请： - 点 `star` - 提 `issue` - 修 `bugs` - 推 `pr` ## 🙆♂️ 感谢在此感谢以下项目提供的支持： - [Halo](https://halo.run) - [Typecho Themes Joe](https://github.com/HaoOuBa/Joe) - [halo-live2d](https://github.com/LIlGG/halo-live2d) - [halo-comment-sakura](https://github.com/LIlGG/halo-comment-sakura) - [halo-theme-sagari](https://github.com/cetr/halo-theme-sagiri)

@"DrLiu"#p11952 > 主题安装后，可能会遇到一些问题，请务必先查看 [主题文档](https://bbchin.com/archives/halo-theme-joe20)，减少沟通成本，或者加入 [Joe2.0 交流群](https://qm.qq.com/cgi-bin/qm/qr?k=JJ3FVO1i_plWJohono16N5z7XI_dqEpK&jump_from=webapi)。

提了个关于`Access key`的`issue`，希望大佬考虑一下🤣

上架到官网了 https://halo.run/archives/joe20.html

我复制了我的歌单ID，歌单部分显示空白，轮播图部分我想修改高度，修改了index.less文件后覆盖更新没生效，又修改min.css后也没生效，该怎么修改

太好看啦！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！

@"LDWBFS"#p10368 1、歌单出不来应该是 `Metingjs` 的 `api` 不稳定导致的，这个我后面单独搭个服务就可以了； 2、目前主题默认使用 `CDN` 加载静态资源，要使用自己修改后的版本，需要在 `后台管理-外观-主题设置-其它` 中关闭 `使用CDN加载静态资源` 即可生效。但关闭后同时也失去了 `CDN` 加载的优势，如果你不想关闭，就需要自己单独修改文件引入处的链接。比如我修改了 `joe.index.min.css` 这个文件，那么就需要到 `template/module/link.ftl` 中找到引入它的地方： ```html ` ``` 把其中的 `${RES_BASE_URL}` 修改为主题自身路径 `${theme_base!}` 即可。 > BTW，目前大部分配置都是约定好的

@"[未知用户]"#p10366 收到

【Joe2.0】Halo-theme-joe2.0 主题发布 🚀🚀🚀

zxblog

如梦令加cdn，另外，这个主题资源太大了，你看看安装包100+mb，期待后面的简洁化

ZTfred

大佬有适配2.0吗

gugu

期待适配2.0🤗

Stars-One

话说内置的看板娘api为啥没出现跨域问题啊,我换了别人的一个API就不行了

是内置的那个看板娘API后台已经做了对应的适配嘛还是主题前端做的适配?

github上提了个issue https://github.com/qinhua/halo-theme-joe2.0/issues/181

kevino

我这里登录https://bbchin.com/浏览网页卡顿，尤其是鼠标滚轮在滚动浏览时特别明显，这是什么原因啊？

Carol

大佬更新到兼容halo2.2.0了么😏

GhostGuest

上海人民发来贺电！

xmtimyang

期待大佬兼容2.2.0

小乌龟鲁啦

期待大佬兼容2.2.0

北海北

期待大佬兼容2.2.0

宽哥

期待大佬兼容2.2.0

tin

这主题用的非常不错，强大实用，反应也挺快的！
多谢大佬无私奉献！

Pacehanhan

这个有提高接口供第三方调用么？或者SDK

Lt1

隐藏评论之后那个目录也不见了

qiu

为啥我安装的主题，进去都是空白页面，啥都没有，是不是要设置什么啊，求求大佬们教我一下😭

狐狸半面添

为什么我这里下载会报错：Internal Server Error: The [theme.yaml] does not conform to the theme specification.

149370949

狐狸半面添
可能你博客装的是2.x版本，这个主题只能支持1.5

erruicoders

期待大佬兼容2.2.0

149370949

希望能支持2.5啦~

qfang

主题安装失败: 缺少 theme.yaml 配置文件或配置文件不符合规范。这是为什么呀？

gugu

qfang 这个主题目前还只支持1.5

« 上一页