diff options
| -rw-r--r-- | .github/ISSUE_TEMPLATE/help.md | 41 | ||||
| -rw-r--r-- | README.md | 22 | ||||
| -rw-r--r-- | assets/css/main/themes.css | 8 | ||||
| -rw-r--r-- | docs/README-en.md | 58 | ||||
| -rw-r--r-- | docs/change-log.md | 9 | ||||
| -rw-r--r-- | docs/project-management.md | 61 |
6 files changed, 132 insertions, 67 deletions
diff --git a/.github/ISSUE_TEMPLATE/help.md b/.github/ISSUE_TEMPLATE/help.md new file mode 100644 index 0000000..9827fbd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/help.md @@ -0,0 +1,41 @@ +--- +name: 需要帮助 +about: 如果你遇到了说明文档无法解决的问题，并且这也不像是一个 bug，可以在这里求助 +title: '' +labels: 求助 +assignees: '' + +--- + +> 注意，在求助的时候请描述清楚你的问题，并保持耐心 +> 在你阅读过这段文本之后，就可以删除这段引用文本 + +**大致范围：** + +这是哪一方面的问题？你是否知道问题所牵连到的文件以及在文件的哪一行？ + +**具体行为描述：** + +你的问题具体是什么？ + +**尝试：** + +你有试过自己解决吗？如果有，请描述你解决的方法和过程，即使它失败了 + +**配置与环境：** + +- 问题页面：（如果有，请提供一个触发此问题的页面链接） +- PHP 版本： +- 数据库类型 / 版本： +- Typecho 版本： +- 主题版本：（Release 标注的版本号，开发版则写 Dev.） +- 使用的插件：（所有使用中的的插件，以便判断兼容性问题） +- 浏览器：（浏览器名称及版本号） + +**截图（若有）** + +提供一个此问题触发的截图或报错信息。若没有，则留空。 + +**补充信息：** + +提供尽可能多的相关信息。 @@ -17,6 +17,7 @@ > 同时，欢迎加入 QQ 交流群：924171480，或者 [Telegram](https://dev.guhub.cn/tg) ## 特色 + - 响应式 / 自适应设计 - Pjax 全站无刷新 - Ajax 评论无刷新 @@ -42,6 +43,7 @@ - 后台设置备份 ## 使用 + 1. Star 本项目（遵循 SATA 开源协议） 2. 下载**最新的 [Release](https://github.com/BigCoke233/miracles/releases)** 3. 解压后，**确认目录名为`Miracles`（M 大写）** @@ -71,23 +73,30 @@ $ git clone https://github.com/BigCoke233/miracles.git </details> ### 更新日志 -**Ver.1.5.3 Fuck Bugs** -- 修复：修复了个寂寞，最后发现根本不是问题，就当测试更新检测好了 +**Ver.1.5.4 Your best nightmare** + +- 增加：适配夜间模式的图标 +可在根目录下创建 faviconDark.ico，如果这个文件存在而系统又为深色模式的时候，就将 favicon 替换成这个文件 +- 优化：移动端下，追番项目一行显示两个 +- 优化：优化夜间模和日落模式 +- 优化：导航栏 :hover 毛玻璃效果优化 +- 移除：提交评论时小电视动画 > 所有历史版本的更新日志请查看[这里](docs/change-log.md) -<details><summary>开发版更新日志 (v20200502)</summary><br> +<details><summary>开发版更新日志 (v20200503A)</summary><br> -- 增加：适配夜间模式的 favicon 图标 -可在根目录下创建 faviconDark.ico，如果这个文件存在而系统又为深色模式的时候，就将 favicon 替换成这个文件 +- 优化：夜间模式下，notice 块的背景色 </details> ## 鸣谢 + > 这些都是在开发过程中给予我帮助的项目和大佬！ ### 开源项目 + - [jQuery](https://github.com/jquery/jquery) - 若干开源项目和主题内一些 js 的前置 - [FancyBox](https://github.com/fancyapps/fancybox) - 文章图片灯箱 - [Highlight.js](https://github.com/highlightjs/highlight.js) - 代码高亮 @@ -101,6 +110,7 @@ $ git clone https://github.com/BigCoke233/miracles.git - [qrcode.js](https://github.com/davidshimjs/qrcodejs) - 生成文章二维码 ### 贡献者 + | 贡献者 | 贡献内容 | | ------ | ------- | | [@BigCoke233 (Eltrac)](https://github.com/BigCoke233) | 原作者 | @@ -114,6 +124,7 @@ $ git clone https://github.com/BigCoke233/miracles.git [Holakit](https://github.com/wenxuanjun/Holakit) | [Material](https://github.com/idawnlight/typecho-theme-material) | [Mirages](https://get233.com/archives/mirages-intro.html) ## 相关 + 演示站点：[我的博客](https://guhub.cn) | 以及 Sponsor 中的站点链接 介绍文章：[Miracles —— 生为奇迹](https://guhub.cn/p/miracles.html) 说明文档：[Wiki](https://www.notion.so/eltrac/c7c631e21b3345caa2a09bd2fb5dd4b2) | [旧的 Wiki](https://mira.guhub.cn) @@ -122,6 +133,7 @@ $ git clone https://github.com/BigCoke233/miracles.git 侵权网站：[black-list.md](docs/black-list.md) ## 捐助 + 你可以通过[爱发电](https://afdian.net/@Eltrac)向我投食，~~用金钱催更~~。 --- diff --git a/assets/css/main/themes.css b/assets/css/main/themes.css index 34c978f..1c5e707 100644 --- a/assets/css/main/themes.css +++ b/assets/css/main/themes.css @@ -17,7 +17,8 @@ */
.body-dark,
.body-dark .post-qr,
-.body-dark .login-form .btn {
+.body-dark .login-form .btn,
+.body-dark .notice {
background: #4b4b4b;
color: #fafafa
}
@@ -219,8 +220,7 @@ .body-dark .search-form input,
.body-dark .login-form button,
.body-dark #comment-form,
-.body-dark .comment-by-author > .comment-body-inner > .comment-main > .comment-meta > .comment-date:before,
-.body-dark .notice {
+.body-dark .comment-by-author > .comment-body-inner > .comment-main > .comment-meta > .comment-date:before {
background:#5a5a5a!important
}
/* Need #6e6e6e bg */
@@ -437,4 +437,4 @@ }
.body-sepia .comment-content.bubble::before {
border-right-color: rgb(250,230,220)
-}
\ No newline at end of file +}
diff --git a/docs/README-en.md b/docs/README-en.md deleted file mode 100644 index 0bf0d98..0000000 --- a/docs/README-en.md +++ /dev/null @@ -1,58 +0,0 @@ -
-
-
-
-
-
-> 🙌 Born to be the Miracles.
-
-Language: [简体中文](/README.md) | English
-
-**Notice: This theme is only for [Typecho](https://github.com/typecho/typecho).**
-# Feature
-- Responsive Web design
-- Pjax
-- LazyLoad
-- Code Highlight by Prism.js
-- Change font-family and font-size when viewing pages
-- Use emotional pictures in comments
-- Live2d
-- A nice dark theme
-- Two interesting filters
-- Two kinds of Nav
-- Custom excerpt when posting
-- Twenty random banner for articles
-- ~~Lightweight (4MB)~~
-
-# Usage
-- Star, please!
-- Download the latest release.
-- Change the name of the folder into `Miracles`
-- Put it into `usr/themes`
-- Start using after reading the [wiki](https://github.com/BigCoke233/miracles/wiki)
-> Sorry, there's no English edition of the wiki now. Maybe you can help me.
-
-# Thanks!
-- [jQuery](https://github.com/jquery/jquery)
-- [FancyBox](https://github.com/fancyapps/fancybox)
-- [Prism.js](https://github.com/PrismJS/prism)
-- [Nprogress](https://github.com/rstacruz/nprogress)
-- [OwO](https://github.com/DIYgod/OwO)
-- [Pjax](https://github.com/defunkt/jquery-pjax)
-- [LazyLoad](https://github.com/tuupola/lazyload)
-- [Pangu.js](https://github.com/vinta/pangu.js)
-
-[@ohmyga233](https://github.com/ohmyga233) |
-[@AlanDecode](https://github.com/AlanDecode) |
-[@gfwyuexia](https://github.com/gfwyuexia) |
-[@jrotty](https://github.com/jrotty)
-
-# Links
-Demo: [My Blog](https://guhub.cn)
-Introduction: [Miracles —— 生为奇迹](https://guhub.cn/p/miracles.html)
-Change-log: [change-log.md](/docs/change-log.md)
-Plan: [plan.md](/docs/plan.md)
-> All above is in Chinese.
-
-# Lincense
-© [Eltrac](https://github.com/BigCoke233/) | Under MIT License.
diff --git a/docs/change-log.md b/docs/change-log.md index 5e813aa..3ced322 100644 --- a/docs/change-log.md +++ b/docs/change-log.md @@ -1,6 +1,15 @@ # 更新日志 这里是 Miracles 主题的更新日志，每个发行版以及开发版的更新内容都会在这里记录，历史版本以及最新版本的下载请到 [Releases](https://github.com/BigCoke233/miracles/releases) 页面，若在使用中有任何问题，请在 issues 中提出或 Pull requests，感谢！ +## Ver.1.5.4 Your best nightmare + +- 增加：适配夜间模式的图标 +可在根目录下创建 faviconDark.ico，如果这个文件存在而系统又为深色模式的时候，就将 favicon 替换成这个文件 +- 优化：移动端下，追番项目一行显示两个 +- 优化：优化夜间模和日落模式 +- 优化：导航栏 :hover 毛玻璃效果优化 +- 移除：提交评论时小电视动画 + ## Ver.1.5.2 Slow Down - 增加：短链接 `[notice][/notice]`，相当于带有 role="note" 的 div diff --git a/docs/project-management.md b/docs/project-management.md new file mode 100644 index 0000000..78289aa --- /dev/null +++ b/docs/project-management.md @@ -0,0 +1,61 @@ +# 项目管理 + +这篇文档记录一些 Miracles 主题在更新维护过程中一些不成文的习惯，写在文档里当作一种规范。 + +## Commit + +在提交 commit 的时候，需要书写 message，通常来说，Miracles 主题所有的 commit message 都应该按照一下格式书写 + +``` +:emoji: <sign>: <summary> +``` + +这里面提到的几个部分不太好直接理解，以下是对他们的解释 + +- `:emoji:`：就是 emoji 字符，应选用和这个 commit 内容有关的 emoji，但主要是为了美观 +- `<sign>`：这个 sign 用来提醒用户这个 commit 更新了什么类型的内容，通常用一下的字符替换 + - `Add`：顾名思义，用在添加新内容/功能的 commit 里 + - `Perf`：这是 perfect 的缩写，通常用于对现有功能进行优化的 commit 里 + - `Del`：即 Delete，表示移除了某些内容 + - `Docs`：即 Documents，表示对某些文档进行了修改，不涉及主体代码 + - `Update`：用于一些无法被归类的 commit，例如：修改版本号 +- `<summary>`：意为总结，就是对更新的内容进行简短的阐述，作为摘要 + +例子：`📐 Perf: 优化了文章盒子的边距` + +这就是一个普通 commit message 的组成，通常只适用于 message 的 header 部分，body 部分是可有可无的，除非你觉得 header 无法完整地表达这次 commit 更新的内容， +就可以在 body 里对这次更新内容进行详细地阐述，没有固定的格式，表述清楚即可。 + +## 版本号 + +如果你仔细观察 Miracles 主题的 release 页面，或者是每个版本的更新日志，你会看到它们通常是这样的 + +``` +:emoji: Ver.<version_num> <name> +``` + +- `:emoji`：就是 emoji 字符，通常选用和这次更新**主题**相关的 emoji +- `<version_num>`：版本号，发行版和开发版的版本号有区别 + - 发行版：通常只有发行版才会有正式的版本号，类似`1.5.2`，`1` 增加代表一次超大更新(几乎重写的那种吧)，`5`增加代表一次大更新(增加了许多新功能)，`2`增加代表补丁这样的小更新(通常只有修复和优化) + - 开发版：开发版的版本号通常以`v`开头，之后是日期，如果这一天有多次开发版更新，则用`A-Z`来区分，例如：`v20200503A`、`v20191223B` +- `<name>`：这个版本的名字，一般是根据更新内容和这次更新的主题来命名 + +> 通常来说，开发版的更新不会写入正式的更新日志（change-log.md） + +## issue + +Miracles 主题有三个自带的 issue 模板，分别是： + +- 问题报告（label：问题） +- 想法建议（label：优化） +- 需要帮助（label：求助） + +正常来说，这三个模板能满足大多数人的要求，并且如果他们按照模板书写 issue 会让开发者更方便。 + +满足以下条件的 issue，会被 close： + +- 问题已被完美解决（label：解决） +- 问题根本不存在（label：错误） +- 这个想法没有必要（label：拒绝） +- 存在相同的内容（label：重复） + |