ITEM

网址导航仪表盘型的 Typecho 主题

项目说明 · 快速开始 · 配置说明 · 交流反馈

🎉 项目说明

✨ Hugo 版现已推出：hugo-theme-item

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

---

🛠️ 快速开始

本地部署

1. 下载 正式版 或者实时构建的 开发版
2. 将主题文件重名为 ITEM 并移动至 Typecho 根目录usr/themes 文件夹中
3. 在 Typecho 管理面板中选择更换外观并启用主题

Warning

必须使用 MySQL，不支持 SQLite 以及 PostgreSQL
推荐 Typecho 1.2+、 PHP 7.4+、 MySQL 8+ 低于这些版本不保证兼容性

Vercel 部署

点击上方 Deploy 按钮 或者 Fork ITEM-vercel 仓库并手动导入 Vercel。

Tip

通过 Vercel 托管需要添加一个 MySQL 集成，如 TiDB、PlanetScale，参考: Vercel 托管 Typecho

本地开发

1. 安装 Docker 以及 Docker Compose 后，在项目根目录下执行以下命令：

   cd .docker
   docker compose up -d

2. 在项目根目录执行以下命令：

   yarn
   yarn watch

完成以上步骤后，浏览器打开 http://localhost:80 即可查看前台页面（账号: dev，密码: 12345678）
此时对源码的任何修改都将实时生效

---

📄️ 配置说明

文章

在本主题中，我们将文章分为以下 3 类

• 网址导航（默认）：点击图标前往文章详情页，点击其他位置直接跳转至对应 url
• 站内文章：顾名思义，与网址导航对应，点击会直接前往文章详情页
• 微信小程序：作为网址导航的分支，点击会直接前往文章详情页

分类

分类略缩名表示对应图标名称，可用图标可在 FontAwesome 5 图标库中浏览；
(例: FontAwesome 图标类名为 <i class="fas fa-vihara"></i> 那么对应略缩名应为 vihara)

搜索引擎

配置格式为 JSON，其中 icon 为 FontAwesome 5 图标， 需要使用 完整类名。 示例如下：

（站内搜索 url 请指向站点 /search 路径）

[
    {
        "name": "站内",
        "url": "/search",
        "icon": "fas fa-search-location"
    },
    {
        "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 格式的颜色值即可。 示例如下：

[
  {
    "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"
  }
]

时间线

请在后台 管理 > 独立页面 > 新增，将其模板设置为 目录/时间线，文章类型设置为 站内文章

---

💬 交流反馈

请在 issues 和 discussions 发表和交换意见，同时也欢迎贡献代码帮助我们完善项目

---

📃 开源许可

基于 GNU General Public License v3.0 协议开源.