356 lines
9.9 KiB
Markdown
356 lines
9.9 KiB
Markdown
<p align="center"><a href="https://shen-yu.gitee.io" target="_blank" rel="noopener noreferrer"><img width="100" src="logo.png" alt="ayer logo"></a></p>
|
||
|
||
<h3 align="center">一个安静且优雅的 Hexo 主题</h3>
|
||
|
||
<p align="center">
|
||
<a href="https://travis-ci.org/Shen-Yu/hexo-theme-ayer?branch=master" target="_blank" rel="noopener noreferrer">
|
||
<img alt="travis-ci" src="https://travis-ci.org/Shen-Yu/hexo-theme-ayer.svg?branch=master">
|
||
</a>
|
||
<a href="http://standardjs.com" target="_blank" rel="noopener noreferrer">
|
||
<img alt="js-standard-style" src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg">
|
||
</a>
|
||
<br>
|
||
<a href="https://hubble.js.org?owner=Shen-Yu&repo=hexo-theme-ayer&start"><img src="https://img.shields.io/badge/since-2019-409eff.svg" alt="Hubble"></a>
|
||
<a href="https://shen-yu.gitee.io" target="_blank" rel="noopener noreferrer">
|
||
<img alt="platform" src="https://img.shields.io/badge/platform-PC--ios--android-e68db8.svg">
|
||
</a>
|
||
<a href="https://gitter.im/hexo-theme-ayer/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge" target="_blank" rel="noopener noreferrer">
|
||
<img alt="Gitter" src="https://badges.gitter.im/Join%20Chat.svg">
|
||
</a>
|
||
<br>
|
||
<a href="https://github.com/Shen-Yu/hexo-theme-ayer/releases" target="_blank" rel="noopener noreferrer">
|
||
<img alt="GitHub package.json version" src="https://img.shields.io/github/package-json/v/Shen-Yu/hexo-theme-ayer">
|
||
</a>
|
||
<img alt="language" src="https://img.shields.io/badge/language-ejs--stylus-green.svg">
|
||
<img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/Shen-Yu/hexo-theme-ayer?color=%23af8ddc">
|
||
<a href="https://github.com/Shen-Yu/hexo-theme-ayer/blob/master/LICENSE" target="_blank" rel="noopener noreferrer"><img alt="LICENSE" src="https://img.shields.io/badge/LICENSE-SATA-efa96e">
|
||
</a>
|
||
</p>
|
||
|
||
---
|
||
|
||
:ocean: Ayer is a clean and elegant theme for Hexo, also fast, powerful and responsive. It contains many awesome features, It's perfect for your blog, "Ayer" means "water" in Malaysian and "yesterday" in Spanish. If you have any queries or advice during the process of using, Please contact me! shenyu@hotmail.com
|
||
|
||
<b>注：收藏本主题请点右上角Star，谢谢~~ </b>
|
||
<b>如果你想给主题添砖加瓦，可以点右上角Fork，然后给此仓库提交PR</b>
|
||
|
||
### [Preview 预览](https://shen-yu.gitee.io)
|
||
|
||
### [中文说明](https://shen-yu.gitee.io/2019/ayer/)
|
||
|
||
### [国内镜像](https://gitee.com/shen-yu/hexo-theme-ayer)
|
||
|
||
|
||
|
||
## Install
|
||
|
||
### For hexo < 5.0
|
||
|
||
``` shell
|
||
git clone https://github.com/Shen-Yu/hexo-theme-ayer.git themes/ayer
|
||
```
|
||
|
||
### For hexo >= 5.0
|
||
|
||
``` shell
|
||
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 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`.
|
||
|
||
## Enable
|
||
|
||
Modify `theme` setting in `_config.yml` to `ayer`
|
||
|
||
``` yml
|
||
theme: ayer
|
||
```
|
||
|
||
## Update
|
||
|
||
``` bash
|
||
cd themes/ayer
|
||
git pull
|
||
```
|
||
|
||
## Multi Language Support
|
||
zh-CN（中文简体） en（English） zh-TW（中文繁体） ja（Japanese） es（Spanish） de（German） fr（French） ru（Russian） ko（Korean） vi（Vietnamese） nl（Dutch） no（Norwegian） pt（Portuguese）
|
||
|
||
English is default languge, if you want to change, modify `language` option in `_config.yml` file in your blog's root folder.
|
||
|
||
## Configuration
|
||
|
||
let me know if you have any questions.
|
||
|
||
``` yml
|
||
# Menu-Sidebar
|
||
menu:
|
||
Home: /
|
||
Archives: /archives
|
||
Categories: /categories
|
||
Tags: /tags
|
||
Gallery: http://shenyu-vip.lofter.com
|
||
Travel: /tags/旅行/
|
||
About: /2019/about
|
||
|
||
# Subtitle and Typing animation
|
||
# https://github.com/mattboldt/typed.js
|
||
subtitle:
|
||
enable: true
|
||
text: A clean and elegant theme
|
||
text2: It's perfect for your hexo blog
|
||
text3: Have fun! #Supports up to three lines of text
|
||
startDelay: 0
|
||
typeSpeed: 200
|
||
loop: true
|
||
backSpeed: 100
|
||
showCursor: true
|
||
|
||
# Favicon and sidebar logo
|
||
favicon: /favicon.ico
|
||
logo: /images/ayer-side.svg
|
||
|
||
# Cover Setting
|
||
# enable: [true|false]；path: [background-image]；logo: [cover-logo-image]
|
||
cover:
|
||
enable: true
|
||
path: /images/cover1.jpg # there are some beautiful cover images in Ayer's directory: /source/images, choose your favorite image to replace it.
|
||
logo: /images/ayer.svg
|
||
|
||
# ProgressBar
|
||
progressBar: true
|
||
|
||
# Article Setting
|
||
# (Use this to excerpt if article is too long：<!--more-->)
|
||
excerpt_link: Read More...
|
||
excerpt_all: false
|
||
|
||
# Copy code button
|
||
copy_btn: true
|
||
# Share
|
||
share_enable: true
|
||
# If you are not in China, maybe you prefer to set:false
|
||
share_china: true
|
||
# share text
|
||
share_text: Share
|
||
# search text
|
||
search_text: Search
|
||
# nav text
|
||
nav_text:
|
||
page_prev: Prev page
|
||
page_next: Next page
|
||
post_prev: Newer posts
|
||
post_next: Older posts
|
||
|
||
# Catalog in article
|
||
toc: true
|
||
|
||
# images in the article support click to fullscreen
|
||
image_viewer: true
|
||
|
||
# https://github.com/willin/hexo-wordcount
|
||
word_count:
|
||
enable: true
|
||
# only display in article page(not in index page)
|
||
only_article_visit: true
|
||
|
||
# Reward Setting
|
||
# type：0-close reward； 1-only open in article which you have configured reward:true； 2-open in all articles
|
||
reward_type: 2
|
||
# reward word
|
||
reward_wording: 'Buy me a cup of coffee~'
|
||
# qrcode image path
|
||
alipay: /images/alipay.jpg
|
||
# qrcode image path
|
||
weixin: /images/wechat.jpg
|
||
|
||
# Copyright
|
||
# type：0-close all； 1-only display in article which you have configured copyright: true； 2-all articles
|
||
copyright_type: 2
|
||
|
||
# Search
|
||
# https://github.com/theme-next/hexo-generator-searchdb
|
||
search: true
|
||
|
||
# RSS
|
||
# leave it empty if you dont' need
|
||
rss: /atom.xml
|
||
|
||
# DarkMode
|
||
darkmode: true
|
||
|
||
# Canvas background style: 0-close，1-moveline
|
||
canvas_bg: 0
|
||
|
||
# Custom mouse pointer，replace /images/mouse.cur
|
||
mouse:
|
||
enable: false
|
||
path: /images/mouse.cur
|
||
|
||
# Click effect: 0-close，1-love，2-boom，3-particles
|
||
click_effect: 0
|
||
|
||
# articleWidth and sidebarWidth
|
||
layout:
|
||
article_width: 80rem
|
||
sidebar_width: 8rem
|
||
|
||
# Comment：1、Valine (recommended)；2、Gitalk
|
||
|
||
# 1、Valine [A fast, simple & powerful comment system](https://github.com/xCss/Valine)
|
||
# You need create leancloud account first (https://console.leancloud.app), then put the id|key in below.
|
||
leancloud:
|
||
enable: true
|
||
app_id: #
|
||
app_key: #
|
||
# Valine Setting
|
||
valine:
|
||
enable: true
|
||
verify: false # comment verify
|
||
avatar: mp # (https://valine.js.org/avatar.html)
|
||
placeholder: Add some comments to my article~ # placeholder
|
||
|
||
# 2、Gitalk(https://github.com/gitalk/gitalk)
|
||
gitalk:
|
||
enable: false # true
|
||
clientID: # GitHub Application Client ID
|
||
clientSecret: # Client Secret
|
||
repo: # Repository name
|
||
owner: # GitHub ID
|
||
admin: # GitHub ID
|
||
|
||
# GitHub Ribbons(https://github.blog/2008-12-19-github-ribbons/)
|
||
github:
|
||
# (Set false if you don't need)
|
||
url: https://github.com/Shen-Yu/hexo-theme-ayer
|
||
|
||
# pv&uv statistics
|
||
busuanzi:
|
||
enable: true
|
||
|
||
# cnzz statistics
|
||
cnzz:
|
||
enable: true
|
||
url: #
|
||
|
||
# Google Analytics
|
||
google_analytics: ''
|
||
# Baidu Analytics
|
||
baidu_analytics: ''
|
||
|
||
# Mathjax Support
|
||
mathjax: true
|
||
|
||
# Katex Support
|
||
# note: need change the hexo-renderer，npm un hexo-renderer-marked -S && npm i hexo-renderer-markdown-it-katex -S
|
||
katex:
|
||
enable: false # true
|
||
allpost: true
|
||
copy_tex: false
|
||
|
||
# since year
|
||
since: 2019
|
||
|
||
# pageFooter (Set true can let more people know this theme, Thanks!)
|
||
pageFooter: true
|
||
```
|
||
|
||
## Plugins
|
||
|
||
+ [hexo-generator-search](https://github.com/wzpan/hexo-generator-search) (for Local Search)
|
||
|
||
```yml
|
||
$ 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):
|
||
|
||
```yml
|
||
# Hexo-generator-search
|
||
search:
|
||
path: search.xml
|
||
field: post
|
||
format: html
|
||
```
|
||
|
||
+ [hexo-generate-feed](https://github.com/hexojs/hexo-generator-feed) (for RSS)
|
||
|
||
```yml
|
||
$ npm install hexo-generator-feed --save
|
||
```
|
||
|
||
Then add the plugin configuration in hexo's configuration file `_config.yml` (note: not the theme's configuration file):
|
||
|
||
```yml
|
||
feed:m
|
||
type: atom
|
||
path: atom.xml
|
||
limit: 20
|
||
hub:
|
||
content:
|
||
content_limit: 140
|
||
content_limit_delim: ' '
|
||
order_by: -date
|
||
```
|
||
|
||
+ [hexo-generator-index-pin-top](https://github.com/netcan/hexo-generator-index-pin-top) (for Sticky Post)
|
||
|
||
``` bash
|
||
$ npm uninstall hexo-generator-index --save
|
||
$ npm install hexo-generator-index-pin-top --save
|
||
```
|
||
## Categories
|
||
``` bash
|
||
hexo new page categories
|
||
```
|
||
Then paste following codes to file: /source/categories/index.md
|
||
``` md
|
||
---
|
||
title: categories
|
||
type: categories
|
||
layout: "categories"
|
||
---
|
||
```
|
||
|
||
## Tags
|
||
Same as categories.
|
||
|
||
## 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.
|
||
|
||
``` md
|
||
---
|
||
title: Gallery
|
||
|
||
albums: [
|
||
["img_url","img_caption"],
|
||
["img_url","img_caption"]
|
||
]
|
||
---
|
||
```
|
||
|
||
## Toc
|
||
|
||
Use Tocbot to parse the title tags (h1~h6) in the content and insert the directory.
|
||
|
||
+ ayer/_config.yml
|
||
|
||
``` bash
|
||
# Toc
|
||
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:
|
||
|
||
``` md
|
||
---
|
||
no_toc: true
|
||
---
|
||
```
|
||
|
||
---
|
||
|
||
<br/>
|
||
<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>.
|
||
|
||
The basic idea is, whenever using a project using SATA license, people shall star/like/+1 that project and thank the author. Just imagine Google stared your project and send you a thank-you letter because they used your project in github!
|