diff --git a/README.md b/README.md index f7b7b2d..801c927 100644 --- a/README.md +++ b/README.md @@ -1,117 +1,79 @@ -## TYPECHO文字博客主题：OneBlog 一款简约清新文艺的写作记录类单栏主题 +### OneBlog主题V3.5.3使用文档 -![oneblog](https://upic.cc/ui/themelogo.png) +本文档仅针对旧版本V3.5.3作特别说明，其他内容与新版本一致。 -### 项目简介 +### 一、作者寄语 -OneBlog，一个博客，再无其他。本主题基于Typecho，设计初衷是写作本身，并无太多其他功能，是一款简约清新文艺风格的写作记录类文字博客主题，适合生活记录、文学作品、个人日志等文字类博客，非文字类博客请慎用。OneBlog主题由[彼岸临窗](https://oneblog.net/)精心打磨多年，且持续优化，现免费开源，致敬互联网社区开源精神，也致敬热爱生活和记录的我们。 +我相信大多数博主都跟我一样，对于自己的后花园秉持着“纵一文不值，也千金不换”的态度。因为这里，承载着我们太多的东西。特别是坚持写下去的博主，在博客中记录，或许是另一种意义上的信仰。我认为，在当下这种浮躁而虚无的生活节奏中，这种信仰很可贵。多年之后，我们回首自己的一生，不该是虚无缥缈的，而应该是真正存在过。那些物质的东西，都会随着时间慢慢销蚀，而我们写下的文字，最趋近于永恒。希望你在用上这款主题之后，不忘初心，坚持把自己的博客写下去。 -官网域名正式升级：即日起，由原有的oneblogx.com永久变更至新顶级域名：[oneblog.net](https://oneblog.net/) +### 二、主题简介 -唯一交流群 - **QQ群：939170079** +OneBlog，一个博客，再无其他。本主题基于Typecho，设计初衷是写作本身，并无太多其他功能，是一款简约文艺风格的写作记录类单栏文字博客主题，适合生活记录、文学作品、个人日志等文字类博客，非文字类博客请慎用。OneBlog主题由彼岸临窗精心打磨多年，且持续优化，现免费开源，致敬互联网社区开源精神，也致敬热爱生活和记录的我们。 -**最新版本：V3.5.3** +### 三、版权声明 -### 主题特性 +本主题由[彼岸临窗](https://oneblog.net)设计编写，并已取得中华人民共和国国家版权局颁发的计算机软件著作权登记证书（登记号：2025SR0334142）和外观设计专利证书（证书号：第7121519号），作者保留所有权利。致敬开源，本主题自2025年1月1日起，以GPL-2.0协议授权广大用户免费使用。任何个人或单位在注明来源的基础上，均可以免费无偿使用本主题，但不得以任何形式售卖（包括但不限于以付费下载、积分购买、vip用户可见等形式向用户提供下载链接，下同），否则视为侵权。基于GPL-2.0协议，本主题允许在保留来源（同时包含署名和链接）的基础上对源代码进行修改，但修改后的源码只能自己使用或免费开源，不得以任何形式售卖。 -✅ **极致的性能，页面加载平均仅需0.03 s；** +### 四、环境配置 -✅ **流畅的体验，无限加载+自动加载数据+图片懒加载；** +#### 1.服务器环境 -✅ **极致的简约风，扁平化设计，简约而不简单；** +推荐使用Linux系统、PHP8.2，Mysql5.7，Ngnix1.24，该环境为开发测试阶段以及主题官网的稳定运行环境，其他环境未作兼容性测试，但不影响正常使用。如有问题，请在Github官方仓库提issue。 -✅ **符合美学的松弛美感，精益求精的留白，让每一次访问都是一种享受；** +#### 2.Typecho版本 -✅ **精雕细琢，精致而优雅的移动端界面；** +本主题基于Typecho1.2.1开发，请在下载本主题之前安装好Typecho官方稳定版。如果你使用的是Typecho旧版本，请自行解决兼容性问题。为了安全性和稳定性考虑，后续主题的更新只可能适配Typecho最新版本。 -**✅ 支持切换PC端护眼模式+移动端黑夜模式；** +如果你还未安装Typecho，请前往[Typecho官网](https://typecho.org/download)下载安装。 -✅ **注释齐全，代码精简，基于OneBlog，你可以最大限度地实现自定义效果。** +#### 3.服务器推荐 -### 主题功能 +如果你想要新购国内服务器，推荐前往[腾讯云最新活动](https://curl.qcloud.com/U7c7Wf2q)选取合适的机器。 -- [x] 文章，聚焦文字本身，沉浸式阅读体验； -- [x] 相册，支持一键同步Unsplash作品； -- [x] 书单，不依赖第三方api，支持记录读书笔记； -- [x] 微语，前台登录和发布，抓住转瞬即逝的灵感； -- [x] 友链，每一位邻居都值得被珍惜和被看见； -- [x] 评论，下拉自动加载；~~评论者地域显示~~（版本号≥3.4.1已移除该功能） -- [x] 归档，干净利落的博客归档页面； -- [x] 搜索，友好的交互体验。 +如果你想新购免备案境外服务器，推荐前往[大圣云计算](https://vps.ink/aff/LIDHBDRC)选取合适的机器。 -### 开发计划 +### 五.主题安装与使用 -本主题的开发计划已全部完成，已知问题已全部修复，合理需求已全部满足，如果你在使用过程中发现任何问题请优先通过本项目的Issues反馈或微信群反馈。对于新功能的建议，请认真了解本主题的设计初衷和官网博客的内容方向后提出，合理化建议会在后续的维护更新中采纳。 +#### 1.下载安装V3.5.3版本 -### 使用文档 +在本仓库切换到old分支后，打包下载即可，下载后确保主题包名称为OneBlog，如果不是请修改文件夹名称即可。 -主题文档：[docs.oneblog.net](https://docs.oneblog.net) +#### 2.初始化 -全网首发：[oneblog.net/oneblog](https://oneblog.net/oneblog) +如果你正确安装了本主题，可以在Typecho后台 [控制台] - [外观]中看到OneBlog和对应版本号。启用主题后，请第一时间到主题外观设置中配置好相关信息并点击保存按钮以便初始化主题配置，否则可能会出现不可预知的问题，尽管本主题在开发过程中已经配置了各种默认数据。 -主题方面的问题请优先在issues中反馈，请勿在博客文章留言区反馈。 +#### 3.推荐安装插件 -关于主题的讨论，请统一在[主题发布页](https://oneblog.net/oneblog)发表。 +由于V3.5.3版本的相册和书房功能模块都是用过文章数据来实现的，即，每一张图片都是一片文章，每一本书籍也是一篇文章，所以建议安装以下插件： -### 版权声明 +[**CateFilter**](https://github.com/woodchen-ink/typecho-plugins-CateFilter) -本主题的所有外观设计专利及软件著作权均归 [©彼岸临窗](https://oneblog.net) 所有，并已取得中华人民共和国国家版权局颁发的计算机软件著作权登记证书（登记号：2025SR0334142）和外观设计专利证书（证书号：第7121519号），作者保留所有权利。致敬开源，本主题自2025年1月1日起，以GPL-2.0协议授权广大用户免费使用。任何个人或单位在注明来源的基础上，均可以免费无偿使用本主题，但不得以任何形式售卖（包括但不限于以付费下载、积分购买、vip用户可见等形式向用户提供下载链接，下同），否则视为侵权。基于GPL-2.0协议，本主题允许在保留来源（同时包含署名和链接）的基础上对源代码进行修改，但修改后的源码只能自己使用或免费开源，不得以任何形式售卖。 +这是一款由Rakiy开发的首页过滤指定分类文章的插件，如果你用到了相册分类、书单分类，建议安装本插件，以便在首页隐藏这些特殊分类的文章。由于本插件的原作者已经停止维护，建议下载安装由woodchen在原插件基础上更新维护的版本。 -### 赞助本项目 +[**Soso**](https://github.com/jrotty/soso) -**开源不易，记得点★Star，支持作者。** +本插件能够增强typecho自带的搜索功能，可以自定义设置只搜索标题或搜索全文，同时支持设置过滤一些分类，让其搜索不到。对于本主题来说，可以通过该插件实现对相册类的文章、书单类的文章进行过滤，让相册、书单不被搜索到。 -你的关注和赞助是这个项目维护下去的坚实动力。 +### 六、个性化设置 -| 通过支付宝赞助 | 通过微信赞助 | -| :-------------------------------------------------------: | :------------------------------------------------------: | -| | | +#### 1.微语 -### 主题预览 +本主题自带微语/说说功能，只需要在后台新建一个独立页面，选择[微语]模板即可。本主题的微语是基于typecho原生评论开发的，因此在独立页面配置好微语页面后，还需要在Typecho后台[设置] - [评论] - 评论显示中配置相关参数。本主题的评论列表均实现了无限加载，因此，在评论设置中必须启用分页功能。 -更多功能模块的演示请访问主题官网了解：[oneblog.net](https://oneblog.net) +推荐设置：☑启用分页，并且每页显示5篇评论，在列出时将第一页作为默认显示；将较新的评论显示在前面。 - +#### 2.书单 -### 版本更新记录 +本主题自带书单功能，方便博主们添加书籍和记录读书笔记。书单功能是通过文章分类实现的，并非独立页面，因此，如果你想要启用书单功能，只需要新增分类“书单”即可，分类缩略名必须修改为“books”。 -``` -V3.5.3版本更新 -1.优化评论区域多层级样式； -2.优化评论输入框的布局，并支持输入框内实时预览表情； -3.更新头像镜像源； -4.优化表格样式； -5.新增自定义CSS、主题色，后续将支持更多个性化设置； -6.其他安全性更新。 +新增书籍时，直接在后台发布新文章即可，标题处填写书籍名称，自定义字段填写书籍相关信息，正文部分填写书籍简介，分类选择书单分类即可。需要记录相关书籍的阅读笔记或者书摘时，登录后进入该书籍的详情页，即可看到输入框。 -V3.5.2版本更新 -1.主题内置自定义菜单； -2.PC端页脚支持显示icp备案号和公安联网备案号； -3.主题文档全新上线； -4.其他细节优化。 +#### 3.相册 -V3.5.1版本更新 -1.文章缩略图逻辑优化； -2.文章列表页缩略图支持自定义图像处理参数； -3.优化归档页样式、文章列表间距； -4.修复移动端黑夜模式下猜你喜欢的文章无法点击的bug； -5.修复移动端黑夜模式下logo显示为护眼模式logo的bug； -6.修复PC端搜索页面错位bug； -7.优化页面/文章关闭评论且没有评论时底部间距过窄的bug。 +本主题自带相册功能，方便博主们持续维护自己的照片。相册页面是通过文章分类来实现的，并非独立页面，因此，如果你想要启用相册功能，只需要新增分类”相册“即可，分类缩略名必须修改为“photos”。 -V3.5版本更新 -1.主题重构，全站性能优化，精简合并所有通用类，规范重写前端样式； -2.新增搜索功能； -3.新增PC端护眼模式和移动端黑夜模式； -4.优化表情模块，兼容CommentNotifier插件，实现邮件通知中也能显示表情； -5.评论区细节优化； -6.优化分类页面、标签页面显示逻辑； -7.支持自定义主题配色； -8.优化重复点赞提示； -9.修复全部已知BUG。 +Unsplash照片同步功能：可自由选择是否开启，开启与否均不影响相册功能的使用。启用本功能需要在后台设置中同时配置好Unsplash API 、 你的Unsplash用户名 、相册分类的mid。配置完毕后，相册页面会自动显示同步按钮。在Unsplash任意客户端或网页版上传照片后建议第一时间同步，同步时不会覆盖已有数据，请放心同步。 -V3.4.3版本更新 -1.新增归档页面； -2.新增独立页面模板：无图单页； -3.性能优化，速度更快； -``` +如果需要自己上传照片，建议在封面图片处填写小尺寸的缩略图，照片原图填写原图地址。如果你想修改相册页面顶部的默认背景，只需要在分类描述中直接填写图片url地址后保存即可。 + +*本文档最后更新于2025年3月27日，由彼岸临窗编写。*