diff options
| author | Eltrac <45323514+BigCoke233@users.noreply.github.com> | 2019-07-26 19:44:46 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-07-26 19:44:46 +0800 |
| commit | 29b21dc65cac090bf47d8921eed6f5c3a5c35f66 (patch) | |
| tree | 91da17f7163d9a7e0230cdd6a55a2771acb50c4c | |
| parent | fed5384d8c83afa4a0f21d5e91da23a68477b986 (diff) | |
A new README.md
| -rw-r--r-- | README.md | 113 |
1 files changed, 83 insertions, 30 deletions
@@ -6,38 +6,79 @@  > 🙌 You're the Miracles. 你即是奇迹 -# 特色 Features -- 自适应设计/响应式设计 -- 白昼模式和夜间模式 -- 扁平化 UI 设计 +# 特色 +- 响应式/自适应设计 - Pjax 预加载技术 - LazyLoad 图片懒加载 -- 丰富的 OwO 评论表情 -- 一些外部样式良好的兼容 -- 说说/动态功能 -- 前台登录 - -# 使用 Usage -1. 到 [Releases](https://github.com/BigCoke233/miracles/releases) 页面下载最新发行版。 -2. Star 本项目 -3. 解压后，检查文件名是否为`Miracles`，若不是请修改。 -4. 根据 [Wiki](https://github.com/BigCoke233/miracles/wiki) 配置本主题 - -# 漏洞 Bugs -所有已知 Bug 均被修复 - -# 计划 Plan -- [x] 增加：前台设置面板（开发版 Done） -- [x] 优化：夜间模式储存 Cookies ，避免刷新后失效 -- [x] 增加：后台主题通知功能 -- [x] 增加：导航栏增加“抽屉栏模式”，可以与顶部导航栏进行切换 -- [x] 增加：全站公告功能 -- [x] 增加：主题内置两只可调戏的猫咪 -- [ ] 增加：Ajax 评论无刷新（目前还是半成品） - -# 版权 Copyright -本项目使用 MIT License 作为开源协议，所以无论你做什么都**请保留主题包中的版权信息**。 -本项目引入了一下的开源项目： +- Prism 代码高亮+行号 +- 前台设置面板，调整字体/字体大小 +- OwO 评论表情 +- 舒适的夜间模式 +- 有趣的日落/黑白滤镜 +- 两种导航栏样式 +- 全站公告 +- 自定义摘要 +- 20 张随机缩略图(文件大的根因) +- ~~体积较小（压缩后 4M 左右）~~ + +# 使用 +1. Star 本项目 +2. 前往 [Releases](https://github.com/BigCoke233/miracles/releases) 下载最新发行版 +3. 解压并存放在`/usr/themes`目录下 +4. 确认目录名是否为`Miracles`（大写 M） +6. 后台-控制台-外观 启用本主题 +7. 阅读 [Wiki](https://github.com/BigCoke233/miracles/wiki) 和后面的常规配置后，开始使用 +## 常规配置 + +<details> +<summary>添加友链（友情链接）</summary> + +在文章或独立页面中按照以下语法书写。 +``` +!!! +[links] +... +[链接名字]{指向链接}(头像) +[链接名字]{指向链接}(头像) +<!-- 例子 --> +[Eltrac]{https://guhub.cn}(https://avatars2.githubusercontent.com/u/45323514?s=96&v=4) +... +[/links] +!!! +``` +> 如果你是 1.0 及以前版本的 Typecho ，可以在开头和结尾添加`!!!` + +</details> +<details> +<summary>关于页面的设置</summary> + +创建关于页面的时候选择“关于页面”模板，然后添加自定义字段，如图。 + + +</details> +<details> +<summary>代码高亮无效?</summary> + +你需要在书写代码块的时候定义语言，这样 Prism.js 才能够正确解析。 +```markdown +(```语言) +相应语言的代码（正常书写时，请去掉括号） +(```) + +(```html) +<a href="#">An A tag.</a>（正常书写时，请去掉括号） +(```) +``` + +> 如果没有定义语言，就会被视作为 html 语言进行解析 + +</details> + +> 在这里未提及的问题请查看 [Wiki](https://github.com/BigCoke233/miracles/wiki) + +# 鸣谢 +> 这些都是在开发过程中给予我帮助的项目和大佬！ +## 开源项目 - [jQuery](https://github.com/jquery/jquery) - [FancyBox](https://github.com/fancyapps/fancybox) - [Prism.js](https://github.com/PrismJS/prism) @@ -47,4 +88,16 @@ - [LazyLoad](https://github.com/tuupola/lazyload) - [Pangu.js](https://github.com/vinta/pangu.js) +## 大佬们 +@ohmyga233 | @AlanDecode | @gfwyuexia | @jrotty + +# 相关 +演示站点：[我的博客](https://guhub.cn) +介绍文章：[Theme Miracles 开源！](https://guhub.cn/p/miracles.html) +更新日志：[change-log.md](https://github.com/BigCoke233/miracles/blob/master/change-log.md) +更新计划：[plan.md](https://github.com/BigCoke233/miracles/blob/master/plan.md) + +# 协议 +© Typecho Theme Miracles is under MIT License. + > Just enjoy it~ |