Skip to content

Commit 01d94b6

Browse files
LIlGGLIlGG
committed
README
1 parent 51714b7 commit 01d94b6

File tree

5 files changed

+185
-112
lines changed

5 files changed

+185
-112
lines changed

‎README.md‎

Lines changed: 158 additions & 109 deletions
Original file line numberDiff line numberDiff line change
@@ -1,109 +1,158 @@
1-
<h1 align="center">Sakura<img src="https://media.giphy.com/media/mGcNjsfWAjY5AEZNw6/giphy.gif" width="50"></h1>
2-
<p align="center">
3-
<a href="https://github.com/halo-dev/halo"><img alt="Halo version" src="https://img.shields.io/badge/halo-2.0.0%2B-brightgreen?style=for-the-badge" /></a>
4-
<a href="https://github.com/LIlGG/halo-theme-sakura"><img alt="Build Status" src="https://img.shields.io/badge/build-positive-brightgreen?style=for-the-badge"></a>
5-
<a href="https://github.com/prettier/prettier"><img alt="Code Style: Prettier" src="https://img.shields.io/badge/release-2.0.0-blue?style=for-the-badge"></a>
6-
<a href="./LICENSE"><img alt="LICENSE MIT" src="https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge"></a>
7-
</p>
8-
<p align="center">
9-
<a href="https://lixingyong.com">预览</a> | <a href="#安装主题">安装</a> | <a href="https://lixingyong.com/2021/01/05/halo%E4%B8%BB%E9%A2%98sakura%E9%A3%9F%E7%94%A8%E8%AF%B4%E6%98%8E">使用文档</a> | <a href="https://lixingyong.com/s/halo-theme-sakure">更新日志</a>
10-
</p>
11-
12-
## 😶 注意！！
13-
目前所在的 [Next 分支版本](https://github.com/LIlGG/halo-theme-sakura/tree/next) 为基于 [Halo 2.x](https://docs.halo.run/) 的主题版本，并不支持 Halo 1.x 版本。若后端仍旧使用 Halo 1.x ，可以前往 [master 分支](https://github.com/LIlGG/halo-theme-sakura/tree/master)下载最新的支持 1.x 版本的主题（1.x 版本会持续进行 BUG 方面的修复）
14-
15-
## 🧐 说明
16-
17-
主题已适配 Halo 2.x 版本，部分不匹配内容将陆续支持。
18-
19-
> 本主题参照 WordPress 主题 [Sakura](https://github.com/mashirozx/Sakura) 制作，在原有的 [Siren](https://github.com/halo-dev/halo-theme-siren) 主题上添加了 Sakura 的内容，并优化了部分内容。
20-
21-
如果各位有什么好的想法，希望可以提交 `ISSUE`，如果有兴趣参与内容贡献，可以直接提交 `PR`；
22-
23-
## 😃 预览
24-
25-
DEMO：[https://lixingyong.com/](https://lixingyong.com/)
26-
27-
截图：
28-
![screenshot.png](https://raw.githubusercontent.com/LIlGG/halo-theme-sakura/master/screenshot.png)
29-
30-
## ⚡ 功能
31-
<details>
32-
<summary>点击查看完整功能列表</summary>
33-
34-
- [x] 完善导航栏，支持图标，支持多级菜单
35-
- [x] 美化首页，支持故障文本和头像
36-
- [x] 集成音乐播放器插件，可在文章中使用
37-
- [x] 全站 Pjax
38-
- [x] ~~背景视频，支持最高 2K 的 Bilibili，支持流加载~~(接口目前有问题)
39-
- [x] 图片懒加载
40-
- [x] 集成 Live2D
41-
- [x] 代码高亮，实现仿 Mac 风格
42-
- [x] ~~自定义评论样式，可以发送表情~~(2.x 不支持)
43-
- [x] 文章目录（支持单个文章内显隐）
44-
- [x] 主题切换
45-
- [x] 自定义友链页面
46-
- [x] 移动客户端适配
47-
- [x] 个人信息（页脚）
48-
- [x] 分享功能（实现部分）
49-
- [x] 分类、标签支持雷达图及云标签
50-
- [x] 全局提示&复制提醒功能
51-
- [x] 瀑布流相册
52-
- [x] 说说页面，支持点赞和评论
53-
- [x] 国际化
54-
- [x] 文章更新时间提醒
55-
56-
57-
> Tip:
58-
>> 上述功能大部分均可配置。具体操作在 后台 -> 外观 -> 主题 -> 设置 中进行配置
59-
</details>
60-
61-
## <img src="https://media.giphy.com/media/WUlplcMpOCEmTGBtBW/giphy.gif" width="30"> 待完成功能
62-
- [ ] 归档重写
63-
- [ ] 集成视频播放插件
64-
65-
## <img src="https://media.giphy.com/media/WUlplcMpOCEmTGBtBW/giphy.gif" width="30"> 待适配功能
66-
- [x] 插件化支持 Live2D，插件地址：[plugin-live2d](https://github.com/LIlGG/plugin-live2d)
67-
- [x] 友链页面，需插件 [plugin-links](https://github.com/halo-sigs/plugin-links) 支持
68-
- [x] 图库页面，需插件 [plugin-photos](https://github.com/halo-sigs/plugin-photos) 支持
69-
- [ ] 说说页面，需插件 [plugin-moments](https://github.com/halo-sigs/plugin-moments)
70-
- [ ] 404 页面
71-
- [ ] 自定义邮件模板
72-
- [x] 用户登录及文章所属用户
73-
- [ ] 自定义符合主题的评论插件
74-
## ⭐️ 安装主题
75-
76-
### 本地安装
77-
1. 点击[下载](https://github.com/LIlGG/halo-theme-sakura/archive/next.zip)
78-
2. 进入 Halo 后台 -> 外观 -> 主题
79-
3. 点击右上角 “主题管理”， 在弹出的窗口中选择 “安装主题”
80-
4. 选择下载好的主题包（zip）
81-
5. 安装完成后的主题将会出现在 “未安装” 内，点击启用主题
82-
83-
## 📄 更新日志
84-
85-
[挖坑日志](https://lixingyong.com/s/halo-theme-sakure)
86-
87-
## 贡献者
88-
89-
感谢这些很优秀的人：
90-
91-
| [<img src="https://avatars2.githubusercontent.com/u/31335418?v=4" width="100px;"/><br /><sub><b>Takagi</b></sub>](https://lixingyong.com/)<br />[💻](https://github.com/LIlGG/halo-theme-sakura/commits?author=LIlGG "编码") [📖](https://github.com/LIlGG/halo-theme-sakura/commits?author=LIlGG "文档") [💡](#example-LIlGG "示例") | [<img src="https://avatars2.githubusercontent.com/u/21301288?v=4" width="100px;"/><br /><sub><b>Ryan Wang</b></sub>](https://ryanc.cc/)<br /> [🎨](#design-ruibaby "设计") [🤔](#design-ruibaby "想法与计划") | [<img src="https://avatars2.githubusercontent.com/u/22992947?v=4" width="100px;"/><br /><sub><b>Parasomnia</b></sub>](https://mashiro.best/)<br /> [💻](https://github.com/LIlGG/halo-theme-sakura/commits?author=parasomn1a "编码") [🎨](#design-parasomn1a "设计") | [<img src="https://avatars2.githubusercontent.com/u/16148054?v=4" width="100px;"/><br /><sub><b>Mashiro</b></sub>](https://2heng.xin/)<br />[🎨](#design-Mashiro "设计") [🤔](#design-Mashiro "想法与思路")|
92-
| :---: | :---: | :---: | :---: |
93-
94-
该项目遵循 [所有参与者](https://github.com/kentcdodds/all-contributors) 规范。
95-
96-
## 赞助
97-
> 由于主题开发需要一定的周期，再加上主题内部 API 所需的服务器和 CDN 都是一笔不小的开支，如果您喜欢我的主题，可以考虑资助一下~ 您的支持将是我继续开发主题的动力。
98-
99-
| <img src="https://cdn.lixingyong.com/img/other/%E5%BE%AE%E4%BF%A1%E5%9B%BE%E7%89%87_20210114094011.jpg" width="160px;"/><br /><b>微信</b><br /> | <img src="https://v-lxy-cdn.oss-cn-beijing.aliyuncs.com/img/other/%E6%94%AF%E4%BB%98%E5%AE%9D.png" width="160px;"/><br /><b>支付宝</b><br /> |
100-
| :---: | :---: |
101-
102-
欢迎其他各种形式的捐助！
103-
104-
## 作者
105-
106-
**halo-theme-sakura** © [LIlGG](https://github.com/LIlGG)，基于 [MIT](./LICENSE) 许可证发行。<br>
107-
作者及其贡献者共有版权 （[帮助维护列表](https://github.com/LIlGG/halo-theme-sakura/graphs/contributors)）。
108-
109-
> [lixingyong.com](https://lixingyong.com) · GitHub [@LIlGG](https://github.com/LIlGG)
1+
<h1 align="center">Sakura<img src="https://media.giphy.com/media/mGcNjsfWAjY5AEZNw6/giphy.gif" width="50"></h1>
2+
<p align="center">
3+
<a href="https://github.com/halo-dev/halo"><img alt="Halo version" src="https://img.shields.io/badge/halo-2.6.0%2B-brightgreen?style=for-the-badge" /></a>
4+
<a href="https://github.com/LIlGG/halo-theme-sakura"><img alt="Build Status" src="https://img.shields.io/badge/build-positive-brightgreen?style=for-the-badge"></a>
5+
<a href="https://github.com/prettier/prettier"><img alt="Code Style: Prettier" src="https://img.shields.io/badge/release-2.0.0.beta2-blue?style=for-the-badge"></a>
6+
<a href="./LICENSE"><img alt="LICENSE MIT" src="https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge"></a>
7+
</p>
8+
<p align="center">
9+
<a href="https://lixingyong.com">预览</a> | <a href="#安装主题">安装</a> | <a href="https://lixingyong.com/2021/01/05/halo%E4%B8%BB%E9%A2%98sakura%E9%A3%9F%E7%94%A8%E8%AF%B4%E6%98%8E">使用文档</a> | <a href="https://github.com/LIlGG/halo-theme-sakura/commits/next">更新记录</a>
10+
</p>
11+
12+
## 😶 注意！！
13+
目前所在的 [Next 分支版本](https://github.com/LIlGG/halo-theme-sakura/tree/next) 为基于 [Halo 2.x](https://docs.halo.run/) 的主题版本，并不支持 Halo 1.x 版本。若后端仍旧使用 Halo 1.x ，可以前往 [master 分支](https://github.com/LIlGG/halo-theme-sakura/tree/master)下载最新的支持 1.x 版本的主题（1.x 版本不再支持更新）
14+
15+
## 🧐 说明
16+
17+
> 本主题参照 WordPress 主题 [Sakura](https://github.com/mashirozx/Sakura) 制作，在原有的 [Siren](https://github.com/halo-dev/halo-theme-siren) 主题上添加了 Sakura 的内容，并优化了部分内容。
18+
19+
如果各位有什么好的想法，希望可以提交 `ISSUE`，如果有兴趣参与内容贡献，可以提交 `PR`；
20+
21+
## 🔥 预览
22+
23+
DEMO：[https://lixingyong.com/](https://lixingyong.com/)
24+
25+
截图：
26+
![screenshot.png](https://raw.githubusercontent.com/LIlGG/halo-theme-sakura/master/screenshot.png)
27+
28+
## ⭐️ 快速入门
29+
30+
### 安装 Halo（已安装可跳过）
31+
32+
前往 [Halo 安装指南](https://docs.halo.run/category/%E5%AE%89%E8%A3%85%E6%8C%87%E5%8D%97) ，按照文档步骤进行安装。
33+
34+
### 安装主题
35+
36+
#### 自动安装（Halo 的版本需要 >= 2.6.0）
37+
38+
主题已上架 [Halo 官方应用市场 - Sakura](https://halo.run/store/apps/app-YGkgz)
39+
40+
1. 点击上方链接直达或者进入 Halo 官方应用市场，找到本主题。
41+
2. 点击左下角 `下载` 按钮。
42+
3. 弹出的对话框中，输入自己的网站地址，点击安装。
43+
![Alt text](/docs/image.png)
44+
45+
#### 手动安装
46+
1. 点击[下载](https://github.com/LIlGG/halo-theme-sakura/archive/next.zip)
47+
2. 进入 Halo 后台 -> 主题
48+
3. 点击右上角 “主题”， 在弹出的窗口中选择 “安装主题”
49+
4. 选择下载好的主题包（zip）
50+
5. 安装完成后的主题将会出现在 “未安装” 内，点击启用主题
51+
52+
### 插件依赖
53+
> 所有插件均为可选，不安装则不会出现对应功能。部分插件可能已经预设在 Halo 内。
54+
55+
- 评论功能，需插件 [plugin-comment-widget](https://github.com/halo-sigs/plugin-comment-widget/releases)
56+
- 搜索功能，需插件 [plugin-search-widget](https://github.com/halo-sigs/plugin-search-widget/releases)
57+
- 友链页面，需插件 [plugin-links](https://github.com/halo-sigs/plugin-links) 支持
58+
- 图库页面，需插件 [plugin-photos](https://github.com/halo-sigs/plugin-photos) 支持
59+
- 说说页面，需插件 [plugin-moments](https://github.com/halo-sigs/plugin-moments) 支持
60+
61+
> 推荐插件
62+
63+
- Live2D 看板娘，插件地址：[plugin-live2d](https://github.com/LIlGG/plugin-live2d)
64+
65+
## ⚡ 功能
66+
67+
<details>
68+
<summary>点击查看完整功能列表</summary>
69+
70+
- [x] 注重性能。主题内资源采用异步加载，延迟加载。
71+
- [x] 完美支持 Pjax。
72+
- [x] SEO 优化。
73+
- [x] 主题国际化。
74+
- [x] 全局使用 svg 图标库。
75+
- [x] 自定义扩展，主题触发各核心功能均会产生 window 事件，方便用户扩展功能。
76+
- [x] 支持深色模式。
77+
- [x] 移动端深入适配。
78+
- [x] 导航栏支持图标、动画，支持二级菜单。
79+
- [x] 完美兼容 Halo 2.x 评论、搜索、瞬间、图库、友链等插件。
80+
- [x] 首页支持故障文本和头像，支持标准与图文双风格切换。
81+
- [x] 支持首页视频，视频支持 HLS 等流媒体。
82+
- [x] 集成音乐播放器插件，支持 [Meting API](https://github.com/injahow/meting-api)。
83+
- [x] 图片懒加载，自适应大小。
84+
- [x] 主题已集成代码高亮，多种高亮支持，实现仿 Mac 风格。
85+
- [x] 主题背景切换
86+
- [x] 自定义友链页面
87+
- [x] 文章目录支持
88+
- [x] 个人信息
89+
- [x] 分享功能
90+
- [x] 分类、标签支持雷达图及云标签
91+
- [x] 全局提示&复制提醒功能
92+
- [x] 瀑布流相册
93+
- [x] 适配瞬间页面，支持点赞及评论。
94+
- [x] 文章字数、更新时间提醒
95+
96+
97+
> Tip:
98+
>> 上述功能大部分均可配置。具体操作在 后台 -> 外观 -> 主题 -> 设置 中进行配置
99+
</details>
100+
101+
## <img src="https://media.giphy.com/media/WUlplcMpOCEmTGBtBW/giphy.gif" width="30"> 待适配功能
102+
103+
- [x] 404 页面
104+
- [ ] 自定义邮件模板，需等待 Halo 支持
105+
- [x] 用户登录及文章所属用户
106+
- [ ] 自定义符合主题的评论插件
107+
108+
## 💫 与 1.x 比较
109+
110+
在主题 2.0.0-beta.2 版本之后，完全重构了主题，因此在功能与性能上，将于 1.x 有很大的区别。
111+
112+
2.x 在很多功能上做了优化，并且较于 1.x 在性能上有了巨大提升，后续将会持续支持 2.x 相关功能，因此目前推荐进行升级，下述表格仅供参考。
113+
114+
| 功能 | 2.x | 1.x | 备注 |
115+
| :---: | :---: | :---: | :---: |
116+
| 全站 Pjax | √ | √ | |
117+
| 主题资源异步加载 | √ | × | |
118+
| 主题资源延迟加载 | √ | × | |
119+
| SEO 优化 | √ | × | |
120+
| 移动端适配 | √ | √ | |
121+
| 深色模式 | √ | √ | |
122+
| 主题自定义评论 | × | √ | |
123+
| 路由搜索 | &bull; | √ | 2.x 支持插件搜索，后续将支持路由搜索 |
124+
| 邮件模板 | × | √ | |
125+
| 看板娘 | √ | √ | 2.x 使用插件支持，并且可以基于 ChatGPT 进行对话 |
126+
| 首页视频 | √ | √ | 2.x 不再支持失效的接口，但默认的本地视频支持 HLS 等流视频 |
127+
| 背景音乐 | √ | √ | 2.x 使用 Meting 接口，因此能够支持多种渠道的音乐 |
128+
| 文章内音乐 | × | √ | 不再支持文章内使用音乐，后续可能使用插件实现 |
129+
| 说说 | √ | √ | 2.x 改名为瞬间 |
130+
| 图库 | √ | √ | |
131+
| 友链 | √ | √ | |
132+
133+
## ☃️ 贡献者
134+
135+
感谢这些很优秀的人：
136+
137+
| [<img src="https://avatars2.githubusercontent.com/u/31335418?v=4" width="100px;"/><br /><sub><b>Takagi</b></sub>](https://lixingyong.com/)<br />[💻](https://github.com/LIlGG/halo-theme-sakura/commits?author=LIlGG "编码") [📖](https://github.com/LIlGG/halo-theme-sakura/commits?author=LIlGG "文档") [💡](#example-LIlGG "示例") | [<img src="https://avatars2.githubusercontent.com/u/21301288?v=4" width="100px;"/><br /><sub><b>Ryan Wang</b></sub>](https://ryanc.cc/)<br /> [🎨](#design-ruibaby "设计") [🤔](#design-ruibaby "想法与计划") | [<img src="https://avatars2.githubusercontent.com/u/22992947?v=4" width="100px;"/><br /><sub><b>Parasomnia</b></sub>](https://mashiro.best/)<br /> [💻](https://github.com/LIlGG/halo-theme-sakura/commits?author=parasomn1a "编码") [🎨](#design-parasomn1a "设计") | [<img src="https://avatars2.githubusercontent.com/u/16148054?v=4" width="100px;"/><br /><sub><b>Mashiro</b></sub>](https://2heng.xin/)<br />[🎨](#design-Mashiro "设计") [🤔](#design-Mashiro "想法与思路")|
138+
| :---: | :---: | :---: | :---: |
139+
140+
该项目遵循 [所有参与者](https://github.com/kentcdodds/all-contributors) 规范。
141+
142+
## 赞助
143+
> 由于主题开发需要一定的周期，再加上主题内部 API 所需的服务器和 CDN 都是一笔不小的开支，如果您喜欢我的主题，可以考虑资助一下~ 您的支持将是我继续开发主题的动力。
144+
145+
| <img src="https://cdn.lixingyong.com/img/other/%E5%BE%AE%E4%BF%A1%E5%9B%BE%E7%89%87_20210114094011.jpg" width="160px;"/><br /><b>微信</b><br /> | <img src="https://v-lxy-cdn.oss-cn-beijing.aliyuncs.com/img/other/%E6%94%AF%E4%BB%98%E5%AE%9D.png" width="160px;"/><br /><b>支付宝</b><br /> |
146+
| :---: | :---: |
147+
148+
欢迎其他各种形式的捐助！
149+
150+
## 作者
151+
152+
**halo-theme-sakura** © [LIlGG](https://github.com/LIlGG)，基于 [MIT](./LICENSE) 许可证发行。<br>
153+
作者及其贡献者共有版权 （[帮助维护列表](https://github.com/LIlGG/halo-theme-sakura/graphs/contributors)）。
154+
155+
> [lixingyong.com](https://lixingyong.com) · GitHub [@LIlGG](https://github.com/LIlGG)
156+
157+
## 希望你喜欢！
158+
![Alt](https://repobeats.axiom.co/api/embed/eab24fbf7d81ae1311c1a7a5878505e66b427bc2.svg "Repobeats analytics image")

‎docs/image.png‎

635 KB
Loading

‎src/languages/README.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,30 @@
1515
- [i18next-localstorage-backend](https://github.com/i18next/i18next-localstorage-backend) - 基于 localStorage 的缓存后端
1616
- [loc-i18next](https://github.com/mthh/loc-i18next) - 对 HTML5 进行国际化的插件
1717

18+
# 开发前准备
19+
20+
TODO
21+
22+
## 开发直达车
23+
24+
- 如果你想添加新语种，可以从 [添加新语种](#添加新语种) 开始查看
25+
- 如果你想编辑现有的语种，可以从 [编辑现有语种](#编辑现有语种) 开始查看
26+
- 如果你想对 HTML 进行编辑，并对其进行国际化，可以从 [在 HTML 中使用](#在-html-中使用) 开始查看。
27+
- 如果你想在 JavaScript 代码中进行国际化处理，可以从 [在 JavaScript 中使用](#在-javascript-中使用) 开始查看。
28+
29+
# 添加新语种
30+
31+
TODO
32+
33+
# 编辑现有语种
34+
35+
36+
# 在 HTML 中使用
37+
38+
# 在 JavaScript 中使用
39+
40+
# 高级功能
41+
## 自定义模板
1842

1943
TODO
2044

‎templates/module/header/user.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
</div>
1818
<div class="user-menu-option">
1919
<!-- 个人资料 -->
20-
<a href="/console#/users/admin/detail" target="_blank" data-i18n="user.info" aria-label="access the personal profile page"></a>
20+
<a href="/console/users/admin/detail" target="_blank" data-i18n="user.info" aria-label="access the personal profile page"></a>
2121
<!-- 退出登录 -->
2222
<a href="/logout" target="_top" data-i18n="user.logout" aria-label="log out of the account"></a>
2323
</div>

‎theme.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ spec:
1717
repo: https://github.com/LIlGG/halo-theme-sakura.git
1818
settingName: theme-sakura-setting
1919
configMapName: theme-sakura-configMap
20-
version: 2.0.0
21-
require: 2.2.0
20+
version: 2.0.0-beta.2
21+
require: 2.6.0
2222
metadata:
2323
name: theme-sakura

0 commit comments

Comments
 (0)