aleks/hexo-theme-ayer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

✏️ README.md

Browse Source
This commit is contained in:
shenyu 2021-05-24 11:45:14 +08:00
parent 221c637409
commit aad79d1baa
1 changed files with 70 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -48,12 +48,6 @@
## Install ## Install
### For hexo < 5.0
``` shell
git clone https://github.com/Shen-Yu/hexo-theme-ayer.git themes/ayer
```
### For hexo >= 5.0 ### For hexo >= 5.0
```shell ```shell
@ -63,6 +57,12 @@ npm i hexo-theme-ayer -S
- If this theme is newly installed, a `_config.ayer.yml` file will be generated in the root directory after the installation is complete, and you can directly edit the `_config.ayer.yml` file for configuration. - If this theme is newly installed, a `_config.ayer.yml` file will be generated in the root directory after the installation is complete, and you can directly edit the `_config.ayer.yml` file for configuration.
- If it is a theme upgrade, you can use the configuration method of hexo < 5.0, or you can move the original configuration file to the root directory and rename it to `_config.ayer.yml`. - If it is a theme upgrade, you can use the configuration method of hexo < 5.0, or you can move the original configuration file to the root directory and rename it to `_config.ayer.yml`.
### For hexo < 5.0
```shell
git clone https://github.com/Shen-Yu/hexo-theme-ayer.git themes/ayer
```
## Enable ## Enable
Modify `theme` setting in `_config.yml` to `ayer` Modify `theme` setting in `_config.yml` to `ayer`
@ -79,6 +79,7 @@ git pull
``` ```
## Multi Language Support ## Multi Language Support
zh-CN（中文简体） en（English） zh-TW（中文繁体） ja（日本語） es（Español） de（Deutsch） fr（Français） ru（Русский） ko（한국어） vi（Tiếng Việt） nl（Nederlands） no（norsk） pt（Português） zh-CN（中文简体） en（English） zh-TW（中文繁体） ja（日本語） es（Español） de（Deutsch） fr（Français） ru（Русский） ko（한국어） vi（Tiếng Việt） nl（Nederlands） no（norsk） pt（Português）
English is default languge, if you want to change, modify `language` option in `_config.yml` file in your Hexo blog's root folder. English is default languge, if you want to change, modify `language` option in `_config.yml` file in your Hexo blog's root folder.
@ -169,7 +170,7 @@ word_count:
# type：0-close reward； 1-only open in article which you have configured reward:true； 2-open in all articles # type：0-close reward； 1-only open in article which you have configured reward:true； 2-open in all articles
reward_type: 2 reward_type: 2
# reward word # reward word
reward_wording: 'Buy me a cup of coffee~' reward_wording: "Buy me a cup of coffee~"
# qrcode image path # qrcode image path
alipay: /images/alipay.jpg alipay: /images/alipay.jpg
# qrcode image path # qrcode image path
@ -222,9 +223,9 @@ cnzz:
url: # url: #
# Google Analytics # Google Analytics
google_analytics: '' google_analytics: ""
# Baidu Analytics # Baidu Analytics
baidu_analytics: '' baidu_analytics: ""
# Mathjax Support # Mathjax Support
mathjax: true mathjax: true
@ -316,11 +317,12 @@ minivaline:
## Plugins ## Plugins
+ [hexo-generator-search](https://github.com/wzpan/hexo-generator-search) (for Local Search) - [hexo-generator-search](https://github.com/wzpan/hexo-generator-search) (for Local Search)
```yml ```yml
$ npm install hexo-generator-searchdb --save $ npm install hexo-generator-searchdb --save
``` ```
Then add the plugin configuration in hexo's configuration file `_config.yml` (note: not the theme's configuration file): Then add the plugin configuration in hexo's configuration file `_config.yml` (note: not the theme's configuration file):
```yml ```yml
@ -331,7 +333,7 @@ minivaline:
format: html format: html
``` ```
+ [hexo-generator-feed](https://github.com/hexojs/hexo-generator-feed) (for RSS) - [hexo-generator-feed](https://github.com/hexojs/hexo-generator-feed) (for RSS)
```yml ```yml
$ npm install hexo-generator-feed --save $ npm install hexo-generator-feed --save
@ -351,17 +353,21 @@ minivaline:
order_by: -date order_by: -date
``` ```
+ [hexo-generator-index-pin-top](https://github.com/netcan/hexo-generator-index-pin-top) (for Sticky Post) - [hexo-generator-index-pin-top](https://github.com/netcan/hexo-generator-index-pin-top) (for Sticky Post)
```bash ```bash
$ npm uninstall hexo-generator-index --save $ npm uninstall hexo-generator-index --save
$ npm install hexo-generator-index-pin-top --save $ npm install hexo-generator-index-pin-top --save
``` ```
## Categories ## Categories
```bash ```bash
hexo new page categories hexo new page categories
``` ```
Then paste following codes to file: /source/categories/index.md Then paste following codes to file: /source/categories/index.md
```md ```md
--- ---
title: categories title: categories
@ -371,13 +377,17 @@ layout: "categories"
``` ```
## Tags ## Tags
Same as categories. Same as categories.
## Friend Links ## Friend Links
```bash ```bash
hexo new page friends hexo new page friends
``` ```
Then paste following codes to file: /source/friends/index.md Then paste following codes to file: /source/friends/index.md
```md ```md
--- ---
title: friends title: friends
@ -385,19 +395,18 @@ type: friends
layout: "friends" layout: "friends"
--- ---
``` ```
Then edit `friends_link` in `_config.yml` Then edit `friends_link` in `_config.yml`
## Gallery ## Gallery
Need to write in the head of the markdown, this is not a good way to write, I hope to get a better way to write on github. Need to write in the head of the markdown, this is not a good way to write, I hope to get a better way to write on github.
```md ```md
--- ---
title: Gallery title: Gallery
albums: [ albums: [["img_url", "img_caption"], ["img_url", "img_caption"]]
["img_url","img_caption"],
["img_url","img_caption"]
]
--- ---
``` ```
@ -405,13 +414,14 @@ albums: [
Use Tocbot to parse the title tags (h1~h6) in the content and insert the directory. Use Tocbot to parse the title tags (h1~h6) in the content and insert the directory.
+ ayer/_config.yml - ayer/\_config.yml
```bash ```bash
# Toc # Toc
toc: true toc: true
``` ```
+ If Toc is turned on in ayer/_config.yml, then Tocbot will generate a Toc article directory in the title tag of each blog parsing content, but not all blogs require Toc, so in the Front-matter section of markdown Can be closed:
- If Toc is turned on in ayer/\_config.yml, then Tocbot will generate a Toc article directory in the title tag of each blog parsing content, but not all blogs require Toc, so in the Front-matter section of markdown Can be closed:
```md ```md
--- ---
@ -433,7 +443,6 @@ This project exists thanks to all the people who contribute.
[![Stargazers over time](https://starchart.cc/Shen-Yu/hexo-theme-ayer.svg)](https://starchart.cc/Shen-Yu/hexo-theme-ayer) [![Stargazers over time](https://starchart.cc/Shen-Yu/hexo-theme-ayer.svg)](https://starchart.cc/Shen-Yu/hexo-theme-ayer)
## License ## License
<a src="https://github.com/Shen-Yu/hexo-theme-ayer">Ayer</a> by <a href="https://github.com/Shen-Yu">Eric-Shen</a> is licensed under <a rel="license" href="https://github.com/Shen-Yu/hexo-theme-ayer/blob/master/LICENSE">SATA-License</a>. <a src="https://github.com/Shen-Yu/hexo-theme-ayer">Ayer</a> by <a href="https://github.com/Shen-Yu">Eric-Shen</a> is licensed under <a rel="license" href="https://github.com/Shen-Yu/hexo-theme-ayer/blob/master/LICENSE">SATA-License</a>.