From fe2fca17b3945100b10f6f8dd08cc5f9ffe355a0 Mon Sep 17 00:00:00 2001 From: KawaiiZapic Date: Fri, 29 Mar 2024 11:45:19 +0800 Subject: [PATCH] chore: update README.md --- README.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 676fe10..547b6aa 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,36 @@ Material Design typecho theme base on MDUI. ![screenshot](https://media.githubusercontent.com/media/KawaiiZapic/Matecho/md3/public/screenshot.png) +## 特性 + +1. 自定义主题色 +2. 使用分块和按需加载技术, 首屏(不包括图片)只需要`100 KBytes`的资源, 根据文章的内容自动确定需要加载的插件. +3. 支持`Fancybox`图片灯箱(按需加载) +4. 支持`Prism`代码高亮(按需加载) +5. 支持`KaTeX`公式渲染(按需加载) +6. 使用最新的Web技术构建, 并向后兼容到`Chrome >= 63`, `Firefox >= 67`, `Safari >= 11`(仅包括有限的支持) + +## 安装 + +1. 从Releases下载最新版的主题文件或者Action中下载自动构建的测试版主题 +2. 将主题解压到`/usr/themes/Matecho/`中 +3. 在Typecho设置中启用主题 + +## 开发 + +``` +pnpm i +pnpm dev +``` + +这将自动检测文件修改并重新构建项目, 将`dist`文件夹软链接到`/usr/themes/Matecho`, 启用主题即可. +这会禁用代码压缩, 不建议用于最终上线环境. + ## 构建 ``` pnpm i -vite build +pnpm build ``` -生成在dist目录下, 重命名dist文件夹到Matecho, 并放在`usr/theme`下. +生成在`dist`目录下, 重命名`dist`文件夹到`Matecho`, 并放在`usr/theme`下.