diff --git a/README.md b/README.md index 1d7a6c8..26ef86c 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,6 @@ -

🎉 项目说明

@@ -42,13 +41,91 @@ 在编程语言中,"item" 这个单词常用来代表一个元素、一个选项 希望这个主题能够承载更多的 "item",链接每一个选项~ +--- +

🛠️ 快速开始

-克隆主题:git clone https://github.com/fordes123/ITEM.git -或下载最新 [Releases](https://github.com/fordes123/ITEM/releases),将文件夹命名为 ITEM 并移动至 typecho 根目录 -usr/themes 文件夹中, 然后在 typecho 后台应用主题即可. +这是一个 Typecho 主题,因此你必须要先安装 Typecho 才能使用它,同时还需要满足以下条件: + +- php 7.4+ +- MySQL 8+ + +### 安装使用 + +1. 获取主题文件 + 克隆仓库源码或下载最新 [Releases](https://github.com/fordes123/ITEM/releases), + ```shell + git clone https://github.com/fordes123/ITEM.git + ``` +2. 将主题文件重名为 ITEM 并移动至 Typecho 根目录usr/themes 文件夹中 +3. 在 Typecho 管理面板中选择更换外观并启用主题 + +--- + +### 配置说明 + +#### 文章配置 + +**文章类型** 为 **网址导航** 时,点击图标前往详情,点击其他位置直接跳转至对应url;**文章类型** 为 **普通文章** 时, +代表站内文章,点击会前往文章页,所以普通文章无需跳转链接 + +#### 分类配置 + +分类略缩名表示对应图标名称,可用图标可在 [FontAwesome 5](https://fontawesome.com/v5/search?o=r&m=free) 图标库中浏览; +(例: FontAwesome 图标类名为 `` 那么对应略缩名应为 `vihara`) + +#### 搜索引擎配置 + +配置格式为 JSON,其中 icon 为 [FontAwesome 5](https://fontawesome.com/v5/search?o=r&m=free) 图标, 需要使用 **完整类名**。 +示例如下: + +```json +[ + { + "name": "谷歌", + "url": "https://www.google.com/search?q=", + "icon": "fab fa-google" + }, + { + "name": "Github", + "url": "https://github.com/search?q=", + "icon": "fab fa-github" + } +] + +``` + +#### 工具直达配置 + +配置格式为 JSON,结构类似 搜索引擎配置,增加了 `background` 控制背景色,填写 css 格式的颜色值即可。 +示例如下: + +```json +[ + { + "name": "热榜速览", + "url": "https://www.hsmy.fun", + "icon": "fas fa-fire", + "background": "linear-gradient(45deg, #97b3ff, #2f66ff)" + }, + { + "name": "地图", + "url": "https://ditu.amap.com/", + "icon": "fas fa-fire", + "background": "red" + }, + { + "name": "微信文件助手", + "url": "https://filehelper.weixin.qq.com", + "icon": "fab fa-weixin", + "background": "#1ba784" + } +] +``` + +---

💬 问题反馈

@@ -57,6 +134,8 @@ Issues - [https://github.com/fordes123/ITEM/issues](https://github.com/fordes123 博客 - [https://fordes.top](https://fordes.top) +--- +

📃 开源许可