更新

2020-11-23 19:01:28 +08:00
1 parent 522abb824b
commit 63389e016a
@@ -0,0 +1,96 @@
+# hexo-theme-butterfly
+
+![version](https://img.shields.io/github/package-json/v/jerryc127/hexo-theme-butterfly)
+![https://img.shields.io/npm/v/hexo-theme-butterfly?color=%09%23bf00ff](https://img.shields.io/npm/v/hexo-theme-butterfly?color=%09%23bf00ff)
+![hexo version](https://img.shields.io/badge/hexo-4.2+-0e83c)
+![npm download](https://img.shields.io/npm/dw/hexo-theme-butterfly?color=green)
+![license](https://img.shields.io/github/license/jerryc127/hexo-theme-butterfly?color=FF5531)
+
+Demo: 👍 [Butterfly](https://butterfly.js.org/)  ||   🤞 [JerryC](https://jerryc.me/)
+
+Docs: 📖 [Butterfly Docs](https://butterfly.js.org/posts/21cfbf15/)
+
+Based on [hexo-theme-melody](https://github.com/Molunerfinn/hexo-theme-melody) theme.
+
+## Installation
+
+### GIT
+
+> If you are in Mainland China, you can download in [Gitee](https://gitee.com/iamjerryw/hexo-theme-butterfly)
+
+Stable branch [recommend]:
+
+```
+git clone -b master https://github.com/jerryc127/hexo-theme-butterfly.git themes/butterfly
+```
+
+Dev branch:
+
+```
+git clone -b dev https://github.com/jerryc127/hexo-theme-butterfly.git themes/butterfly
+```
+
+### NPM
+
+> It supports Hexo 5.0.0 or later
+
+In Hexo site root directory 
+
+```powershell
+npm i hexo-theme-butterfly
+```
+
+## Configuration
+
+ Set theme in the hexo work folder's root config file `_config.yml`: 
+
+> theme: butterfly
+
+ If you don't have pug & stylus renderer, try this: 
+
+> npm install hexo-renderer-pug hexo-renderer-stylus
+
+## Features
+
+- [x] Card UI Design
+- [X] Support sub-menu
+- [x] Two Column designs
+- [x] Responsive Web Design
+- [x] Dark Mode
+- [x] Pjax
+- [x] Read Mode
+- [x] Conversion between Traditional and Simplified Chinese
+- [X] TOC catalog is available for both computers and mobile phones
+- [X] Color themes (darker/pale night/light/ocean/mac/mac light), support custom colors
+- [X] Code Blocks (Display code language/close or expand Code Blocks/Copy Button/word wrap)
+- [X] Disable copy/Add a Copyright Notice to the Copied Text
+- [X] Search (Algolia SearchZ/Local Search)
+- [x] Mathjax and Katex
+- [x] Built-in 404 page
+- [x] WordCount
+- [x] Related articles
+- [x] Displays outdated notice for a post
+- [x] Share (AddThis/Sharejs/Addtoany)
+- [X] Comment (Disqus/Disqusjs/Livere/Gitalk/Valine/Utterances/Facebook Comments)
+- [x] Multiple Comment System Support
+- [x] Online Chats (Chatra/Tidio/Daovoice/Gitter/Crisp)
+- [x] Web analytics (Baidu Analytics/Google Analytics/Tencent Analytics/CNZZ Analytics)
+- [x] Google AdSense
+- [x] Webmaster Verification (google/Bing/Baidu/360/Yandex)
+- [x] Change website colour scheme
+- [x] Typewriter Effect: activate_power_mode
+- [x] Background effects (Canvas ribbon/canvas_ribbon_piao/canvas_nest)
+- [x] Mouse click effects (Fireworks/Heart/Text)
+- [x] Preloader/Loading Animation
+- [x] Busuanzi visitor counter
+- [x] Medium Zoom/Fancybox
+- [x] Mermaid
+- [x] Justified Gallery
+- [x] Lazyload images
+- [x] Instantpage/Pangu/Snackbar notification toast/PWA......
+
+## Screenshots
+
+![](https://cdn.jsdelivr.net/gh/jerryc127/CDN/img/theme-butterfly-readme-homepage-1.png)
+
+![](https://cdn.jsdelivr.net/gh/jerryc127/CDN/img/theme-butterfly-readme-homepage-2.png)