QuickReference/themes/anzhiyu/README_EN.md

141 lines
6.9 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<p align="center">
<a title="Hexo Version" target="_blank" href="https://hexo.io/zh-cn/"><img alt="Hexo Version" src="https://img.shields.io/badge/Hexo-%3E%3D%205.3.0-orange?style=flat"></a>
<a title="Node Version" target="_blank" href="https://nodejs.org/zh-cn/"><img alt="Node Version" src="https://img.shields.io/badge/Node-%3E%3D%2010.13.0-yellowgreen?style=flat"></a>
<a title="License" target="_blank" href="https://github.com/anzhiyu-c/hexo-theme-anzhiyu/blob/master/LICENSE"><img alt="License" src="https://img.shields.io/github/license/anzhiyu-c/hexo-theme-anzhiyu.svg?style=flat"></a>
<br>
<a title="GitHub Release" target="_blank" href="https://github.com/anzhiyu-c/hexo-theme-anzhiyu/releases"><img alt="GitHub Release" src="https://img.shields.io/github/v/release/anzhiyu-c/hexo-theme-anzhiyu?style=flat"></a>
<a title="Npm Downloads" target="_blank" href="https://www.npmjs.com/package/hexo-theme-anzhiyu"><img alt="Npm Downloads" src="https://img.shields.io/npm/dt/hexo-theme-anzhiyu?color=red&label=npm"></a>
<a title="GitHub Commits" target="_blank" href="https://github.com/anzhiyu-c/hexo-theme-anzhiyu/commits/master"><img alt="GitHub Commits" src="https://img.shields.io/github/commit-activity/m/anzhiyu-c/hexo-theme-anzhiyu.svg?style=flat&color=brightgreen&label=commits"></a>
<br><br>
<a title="GitHub Watchers" target="_blank" href="https://github.com/anzhiyu-c/hexo-theme-anzhiyu/watchers"><img alt="GitHub Watchers" src="https://img.shields.io/github/watchers/anzhiyu-c/hexo-theme-anzhiyu.svg?label=Watchers&style=social"></a>
<a title="GitHub Stars" target="_blank" href="https://github.com/anzhiyu-c/hexo-theme-anzhiyu/stargazers"><img alt="GitHub Stars" src="https://img.shields.io/github/stars/anzhiyu-c/hexo-theme-anzhiyu.svg?label=Stars&style=social"></a>
<a title="GitHub Forks" target="_blank" href="https://github.com/anzhiyu-c/hexo-theme-anzhiyu/network/members"><img alt="GitHub Forks" src="https://img.shields.io/github/forks/anzhiyu-c/hexo-theme-anzhiyu.svg?label=Forks&style=social"></a>
</p>
<p align="center"><a title="中文" href="/README.md">🇨🇳 中文简体</a> | 🇬🇧 English</p>
Preview: 👍 [AnZhiYu](https://blog.anheyu.com/) || 🤞 [AnZhiYu](https://index.anheyu.com/)
Document: 📖 [anzhiyu Docs](https://docs.anheyu.com/)
A theme based on [hexo-theme-butterfly](https://github.com/jerryc127/hexo-theme-butterfly) modification
# hexo-theme-anzhiyu
![](https://bu.dusays.com/2023/07/24/64bdcbfe96762.webp)
## 💻 安裝
### Git 安裝
Install the latest version in the root directory of the blog [recommended]
```powershell
git clone -b main https://github.com/anzhiyu-c/hexo-theme-anzhiyu.git themes/anzhiyu
```
## ⚙ 应用主题
Modify the hexo configuration file `_ config.yml` and change the theme to `anzhiyu`
```
theme: anzhiyu
```
> If you do not have a renderer for pug and stylus, please download and install `npm install hexo-renderer-pug hexo-renderer-stylus --save`
## Override configuration
Override configuration allows the `theme configuration `to be placed outside the anzhiyu directory to avoid losing custom configurations when updating the theme.
Users who install the theme through Npm can ignore it, and other users are recommended to learn to use it.
- macos/linux
Run in the blog root directory
```bash
cp -rf ./themes/anzhiyu/_config.yml ./_config.anzhiyu.yml
```
- windows
Copy the file `/ themes/anzhiyu/_ config.yml` to the hexo root directory and rename it to` _ config.anzhiyu.yml`
If you modify any theme configuration in the future, you only need to modify the configuration of_config.anzhiyu.yml.
Note:
- as long as the configurations that exist in `_ config.anzhiyu.yml` are of high priority, it is invalid to modify the original` _ config.yml`.
- there may be configuration changes each time the topic is updated. Please pay attention to the update instructions. You may need to manually modify `_ config.anzhiyu.yml`.
- to check whether the override configuration has taken effect, you can check the command line output via `override g-- debug`.
- if you want to overwrite some configurations to empty, be careful not to delete the primary key, otherwise it cannot be overwritten
## Functional characteristics
-✅ extremely detailed [user documentation] (https://docs.anheyu.com/)
-✅ Page components load lazily (pjax scheme)
-✅ the picture is loaded lazily
-✅ multiple code highlighting schemes
-✅ multilingual configuration
-✅ built-in multiple comment plug-ins
-✅ built-in web page access statistics
-✅ supports dark mode
-✅ supports footnote syntax
-✅ support custom CDN static resources
-✅ A rich variety of tag options to quickly build the features you want
-✅ supports customized right-click menus
-✅ support customized dominant tone to vary with the color of the cover image
-✅ support for immersive status bar
-✅ support article word statistics
-✅ support chat system
-✅ support Google Analytics, Baidu Analytics, Microsoft Analytics, cloudflare Analytics, cnzz Analytics
-✅ Advertising is supported
-✅ large picture view is supported
-✅ support waterfall flow and talk about it right away
-✅ supports waterfall stream album
-✅ supports Ali icon and fontawesome
-✅ supports cached swpp,pwa features
-✅ excellent privacy protocol support
-✅ AI abstract support for articles
-✅ support music ball
-✅ supports the global center console
-✅ supports shortcut key options
-✅ support local search / algolia search 🔍 / Docsearch
-✅ supports LaTeX mathematical formula
-✅ support mermaid flow chart
## Partial function display
**Immersive status bar**
Immerse yourself in reading.
![Immersive status bar](https://upload-bbs.miyoushe.com/upload/2023/09/04/125766904/3bc088e73d07b4dc25fc62fa4cf63261_4205905123525229755.png)
**Customized right-click menu**
Highly customized.
![ High and low custom right-click menu](https://upload-bbs.miyoushe.com/upload/2023/09/04/125766904/3f66e33b24a758d53717f6c2c44e50af_1884994888952376370.png)
**AI Summary**
Read articles quickly.
![AI Summary](https://upload-bbs.miyoushe.com/upload/2023/09/04/125766904/184e089d64660f5f72390f547c864633_3266246986824356702.png)
**A refreshing interface that makes people shine at the moment**
![A refreshing interface that makes people shine at the moment](https://upload-bbs.miyoushe.com/upload/2023/09/04/125766904/8a16284fd36a9e986d5dbda772f697d0_1356079755877317976.png)
**Comment Barrage**
![Comment Barrage](https://upload-bbs.miyoushe.com/upload/2023/09/04/125766904/628aef1dbf52b61c0333682e8ee9954e_6905019516821534667.png)
## Contributors
[![contributors](https://opencollective.com/hexo-theme-anzhiyu/contributors.svg?width=890&button=false)](https://github.com/anzhiyu-c/hexo-theme-anzhiyu/)
Theme Design[@张洪 Heo](https://github.com/zhheo)
Document writing[@xiaoran](https://github.com/xiaoran)
## Warehouse Statistics
![Warehouse Statistics](https://repobeats.axiom.co/api/embed/60fcf455cd02123aebe6249deabf8d48e3debcae.svg "Repobeats analytics image")