docs: update README
This commit is contained in:
XPoet
parent
145272ff15
commit
21967437aa
225
README.md
225
README.md
|
|
@ -6,8 +6,8 @@
|
|||
[](https://nodejs.org/)
|
||||
[](https://hexo.io)
|
||||
|
||||
**一款简约轻快的 Hexo 主题。**
|
||||
**A simple and light theme for Hexo.**
|
||||
**一款简约漂亮的 Hexo 主题。**
|
||||
**A simple and beautiful theme for Hexo.**
|
||||
|
||||
|
||||
|
||||
|
|
@ -70,7 +70,7 @@
|
|||
- [x] 文章阅读次数统计。
|
||||
- [x] 文章字数统计。
|
||||
- [x] 文章阅读时长统计。
|
||||
- [x] 页面滚动百分比提示。
|
||||
- [x] 页面滚动进度条提示。
|
||||
- [x] 一键快速回到顶部。
|
||||
- [x] 无 jQuery，代码精简。
|
||||
|
||||
|
|
@ -126,15 +126,29 @@ theme: ils
|
|||
|
||||
### Configuration 配置
|
||||
|
||||
主题的配置文件的详细说明，强烈建议多看几遍，并且对照着来修改自己的配置文件，边修改边查看页面效果。
|
||||
|
||||
```yml
|
||||
# theme basic info
|
||||
# 主题基本信息，无需改动。
|
||||
# ------------------------------------------------------------
|
||||
# Theme basic info (please don't change)
|
||||
# 主题基本信息，请不要改动。
|
||||
# ------------------------------------------------------------
|
||||
theme_info:
|
||||
name: ILS
|
||||
version: 2.0.1
|
||||
author: XPoet
|
||||
repository: https://github.com/XPoet/hexo-theme-ils
|
||||
|
||||
|
||||
# ------------------------------------------------------------
|
||||
# Theme style settings
|
||||
# 主题样式设置
|
||||
# ------------------------------------------------------------
|
||||
style:
|
||||
# Theme primary color
|
||||
# 主题的主颜色，修改为自己喜欢的颜色即可，支持 rgb、十六进制格式。
|
||||
primary_color: "#0066CC"
|
||||
|
||||
# favicon
|
||||
# 网站图标，把 "/source/images/" 目录下的 "favicon.png"，换成自己的图片即可。
|
||||
favicon: images/favicon.png
|
||||
|
|
@ -143,37 +157,55 @@ favicon: images/favicon.png
|
|||
# 头像图片，把 "/source/images/" 目录下的 "avatar.png"，换成自己的图片即可。
|
||||
avatar: images/avatar.png
|
||||
|
||||
# navigation menu
|
||||
# 导航菜单，如需新增导航，请按下面格式填写，同时需要添加对应的 Hexo 页面。
|
||||
# 如何新增页面，请参考下面的教程："Add page 添加页面"。
|
||||
|
||||
# ------------------------------------------------------------
|
||||
# Navigation menu
|
||||
# 导航菜单
|
||||
# 如需新增导航页，请按下面格式填写，同时需要创建对应的 Hexo 页面。
|
||||
# 如何新增页面，请参考下面的教程：“Add page 添加页面”。
|
||||
# ------------------------------------------------------------
|
||||
menu:
|
||||
Home: /
|
||||
Archives: /archives
|
||||
# Categories: /categories
|
||||
# About: /about
|
||||
# Tags: /tags
|
||||
# Links: /links
|
||||
# About: /about
|
||||
# ...
|
||||
|
||||
# RSS
|
||||
# RSS 订阅，如需启用，请先安装 Hexo 插件：hexo-generator-feed。
|
||||
# 在博客根目录下使用 npm 命令安装: npm i hexo-generator-feed --save
|
||||
rss:
|
||||
enable: true
|
||||
|
||||
# comment plugin
|
||||
# 评论插件，主题内置了 Valine 和 Gitalk，只能使用其中一款，如果 enable 都设为了 true，将使用 Valine。
|
||||
# ------------------------------------------------------------
|
||||
# RSS
|
||||
# Dependencies: hexo-generator-feed
|
||||
# See: https://github.com/hexojs/hexo-generator-feed
|
||||
# RSS 订阅，如需启用，请先安装 Hexo 插件：hexo-generator-feed。
|
||||
# 具体步骤，参考下面的教程：“RSS 订阅”。
|
||||
# ------------------------------------------------------------
|
||||
rss:
|
||||
enable: false
|
||||
|
||||
|
||||
# ------------------------------------------------------------
|
||||
# Comment plugin
|
||||
# 评论插件
|
||||
# 主题内置了 Valine 和 Gitalk，只能使用其中一款。
|
||||
# ------------------------------------------------------------
|
||||
comments:
|
||||
# Valine https://github.com/xCss/Valine
|
||||
# 如何使用 Valine 请参考官方教程：https://github.com/xCss/Valine
|
||||
# Valine
|
||||
# See: https://github.com/xCss/Valine
|
||||
# 如何使用 Valine，请参考官方教程：https://github.com/xCss/Valine
|
||||
# 获取必要的参数，在下面填写。
|
||||
valine:
|
||||
enable: false
|
||||
appid: # leancloud appid
|
||||
appkey: # leancloud appkey
|
||||
meta: ["nick", "mail", "link"]
|
||||
placeholder: 😜尽情吐槽吧~
|
||||
appid: # your leancloud application appid
|
||||
appkey: # your leancloud application appkey
|
||||
meta: # comment input meta, type: Array, values: ['nick','mail','link']
|
||||
placeholder: # your placeholder
|
||||
|
||||
# Gitalk https://github.com/gitalk/gitalk
|
||||
# 如何使用 Gitalk 请参考官方教程：https://github.com/gitalk/gitalk
|
||||
# Gitalk
|
||||
# See: https://github.com/gitalk/gitalk
|
||||
# 如何使用 Gitalk，请参考官方教程：https://github.com/gitalk/gitalk
|
||||
# 获取必要的参数，在下面填写。
|
||||
gitalk:
|
||||
enable: false
|
||||
github_id: # GitHub repo owner
|
||||
|
|
@ -181,13 +213,17 @@ comments:
|
|||
client_id: # GitHub Application Client ID
|
||||
client_secret: # GitHub Application Client Secret
|
||||
|
||||
# website count
|
||||
|
||||
# ------------------------------------------------------------
|
||||
# Website count
|
||||
# 网站计数
|
||||
# ------------------------------------------------------------
|
||||
website_count:
|
||||
# busuanzi http://ibruce.info/2015/04/04/busuanzi/
|
||||
# 主题内置“不蒜子”计数，无需额外配置，只需选择开启想要的计数
|
||||
# busuanzi
|
||||
# See: http://ibruce.info/2015/04/04/busuanzi/
|
||||
# 主题内置“不蒜子”计数，无需额外配置，选择你要开启的计数项即可。
|
||||
# site_uv 访问人数计数
|
||||
# site_pv 访问量计数
|
||||
# site_pv 总访问量计数
|
||||
# page_pv 文章阅读量计数
|
||||
busuanzi_count:
|
||||
enable: false
|
||||
|
|
@ -195,77 +231,111 @@ website_count:
|
|||
site_pv: false
|
||||
page_pv: false
|
||||
|
||||
|
||||
# ------------------------------------------------------------
|
||||
# Local Search
|
||||
# Dependencies: https://github.com/theme-next/hexo-generator-searchdb
|
||||
# Dependencies: hexo-generator-searchdb
|
||||
# See: https://github.com/theme-next/hexo-generator-searchdb
|
||||
# 本地搜索，如需启用，请先安装 Hexo 插件：hexo-generator-searchdb。
|
||||
# 在博客根目录下使用 npm 命令安装: npm i hexo-generator-searchdb --save
|
||||
# 具体步骤，参考下面的教程：“Local search 本地搜索”。
|
||||
# ------------------------------------------------------------
|
||||
local_search:
|
||||
enable: true
|
||||
|
||||
# If auto, trigger search by changing input.
|
||||
# If manual, trigger search by pressing enter key or search button.
|
||||
# trigger 搜索触发方式，输入关键字后会触发搜索，可选 auto（自动）或 manual（手动）。
|
||||
# auto 每输入或删除一个字符后，自动触发搜索。
|
||||
# manual 每输入或删除一个字符后，需要按回车键触发搜索。
|
||||
### auto 每输入或删除一个字符后，自动触发搜索。
|
||||
### manual 每输入或删除一个字符后，需要按回车键触发搜索。
|
||||
trigger: auto # values: auto | manual
|
||||
|
||||
# Unescape html strings to the readable one.
|
||||
# 转义 HTML 字符串为可读字符串。
|
||||
# # 转义 HTML 字符串为可读字符串。
|
||||
unescape: false
|
||||
|
||||
# Preload the search data when the page loads.
|
||||
# 在页面加载时预加载搜索数据
|
||||
preload: true
|
||||
# 在页面加载时预加载搜索数据。
|
||||
preload: false
|
||||
|
||||
# 文章字数统计、阅读时长
|
||||
|
||||
# ------------------------------------------------------------
|
||||
# Post word count
|
||||
# Dependencies: hexo-wordcount
|
||||
# See: https://github.com/willin/hexo-wordcount
|
||||
# 文章字数统计 & 阅读时长统计
|
||||
# 如需启用，请先安装 Hexo 插件：hexo-wordcount。
|
||||
# 在博客根目录下使用 npm 命令安装: npm i hexo-wordcount --save
|
||||
# ------------------------------------------------------------
|
||||
post_wordcount:
|
||||
wordcount: true # 字数统计
|
||||
min2read: true # 阅读时长
|
||||
enable: false
|
||||
wordcount: false # word count, one article
|
||||
min2read: false # time to read, one article
|
||||
|
||||
|
||||
# ------------------------------------------------------------
|
||||
# Home page article block display settings
|
||||
# 首页文章底部的显示设置，可配置显示分类和标签
|
||||
# 首页文章块底部的显示设置，可配置显示分类和标签。
|
||||
# limit 显示分类或标签的最大个数。
|
||||
# ------------------------------------------------------------
|
||||
home_article:
|
||||
category: true # show category in article block
|
||||
tag: true # show tags in article block
|
||||
tag_limit: 5 # max number of tags shown in article block
|
||||
category:
|
||||
enable: false # show category in home page article block
|
||||
limit: 3 # max number of categories shown in home page article block
|
||||
tag:
|
||||
enable: false # show tags in home page article block
|
||||
limit: 5 # max number of tags shown in home page article block
|
||||
|
||||
# Code Copy
|
||||
# 代码复制，复制风格可选 default | flat | mac。
|
||||
|
||||
# ------------------------------------------------------------
|
||||
# Code copy
|
||||
# 代码复制，代码块的复制风格可选 default | flat | mac。
|
||||
# ------------------------------------------------------------
|
||||
code_copy:
|
||||
enable: true
|
||||
style: flat # values: default | flat | mac
|
||||
|
||||
# sidebar tools
|
||||
# 侧边栏工具，位置可选 left | right。
|
||||
|
||||
# ------------------------------------------------------------
|
||||
# Sidebar tools
|
||||
# 侧边栏工具（搜索按钮、昼夜模式切换按钮、RSS按钮、TOC显示切换按钮）
|
||||
# ------------------------------------------------------------
|
||||
side_tools:
|
||||
enable: true
|
||||
position: right # values: left | right
|
||||
enable: false
|
||||
|
||||
# back to top
|
||||
# 回到顶部，位置可选 left | right。
|
||||
|
||||
# ------------------------------------------------------------
|
||||
# Back to top
|
||||
# 回到顶部
|
||||
# ------------------------------------------------------------
|
||||
back2top:
|
||||
enable: true
|
||||
position: right # values: left | right
|
||||
enable: false
|
||||
|
||||
|
||||
# ------------------------------------------------------------
|
||||
# Table of Contents in the Sidebar
|
||||
# 文章目录结构
|
||||
# ------------------------------------------------------------
|
||||
toc:
|
||||
enable: true
|
||||
enable: false
|
||||
|
||||
# Automatically add list number to toc.
|
||||
# 给文章目录自动加上序号。
|
||||
number: true
|
||||
|
||||
# If true, all level of TOC in a post will be displayed, rather than the activated part of it.
|
||||
# 是否展开所有目录
|
||||
# 是否展开所有目录。
|
||||
expand_all: true
|
||||
|
||||
# magic
|
||||
# magic 为 v1.1.0 增加的新特性，启用后，主题样式将以简约的卡片形式显示。
|
||||
|
||||
# ------------------------------------------------------------
|
||||
# Magic
|
||||
# magic 启用后，主题将以简约的卡片形式显示。
|
||||
# 可分别配置缩放效果、阴影效果。
|
||||
# ------------------------------------------------------------
|
||||
magic:
|
||||
enable: true # 是否开启 magic 风格
|
||||
scale: false # 是否开启缩放效果
|
||||
shadow: true # 是否开启阴影效果
|
||||
enable: true
|
||||
scale: false # scale effect when the mouse hover
|
||||
shadow: false # shadow effect when the mouse hover
|
||||
```
|
||||
|
||||
### Comment 评论
|
||||
|
|
@ -286,13 +356,13 @@ magic:
|
|||
|
||||
### Post top 文章顶置
|
||||
|
||||
实现文章顶置功能，需在 Hexo 博客根目录下安装插件 **hexo-generator-index-pin-top**。
|
||||
实现文章顶置功能，需在 Hexo 博客根目录下安装插件 **`hexo-generator-index-pin-top`**。
|
||||
|
||||
```bash
|
||||
npm install hexo-generator-index-pin-top
|
||||
```
|
||||
|
||||
然后在 `_posts` 文件夹里的需要顶置的文章页添加 `top` 属性，**top** 值越大，顶置越靠前，参考如下。
|
||||
然后在 `_posts` 文件夹里的需要顶置的文章页添加 `top` 属性，**top** 值越大，顶置文章越靠前，参考如下。
|
||||
|
||||
```markdown
|
||||
---
|
||||
|
|
@ -306,7 +376,7 @@ top: 9999
|
|||
|
||||
### Local search 本地搜索
|
||||
|
||||
1. 启用本地搜索功能，需在 Hexo 博客根目录下安装插件 **hexo-generator-searchdb**。
|
||||
1. 启用本地搜索功能，需在 Hexo 博客根目录下安装插件 **`hexo-generator-searchdb`**。
|
||||
|
||||
```bash
|
||||
npm install hexo-generator-searchdb
|
||||
|
|
@ -334,6 +404,32 @@ top: 9999
|
|||
preload: true
|
||||
```
|
||||
|
||||
### RSS 订阅
|
||||
|
||||
1. 启用 RSS 订阅功能，需先在 Hexo 博客根目录下安装插件 **`hexo-generator-feed`**。
|
||||
|
||||
```bash
|
||||
npm install hexo-generator-feed
|
||||
```
|
||||
|
||||
2. 在 Hexo 配置文件 `_config.yml` 增加如下配置。
|
||||
|
||||
```yml
|
||||
# Feed Atom
|
||||
# npm install hexo-generator-feed
|
||||
feed:
|
||||
type: atom
|
||||
path: atom.xml
|
||||
limit: 20
|
||||
```
|
||||
|
||||
3. 修改主题配置文件 `_config.yml`。
|
||||
|
||||
```yml
|
||||
rss:
|
||||
enable: true
|
||||
```
|
||||
|
||||
### Add page 添加页面
|
||||
|
||||
**Hexo 初始并没有 categories、about、links、tags 等页面，需要自己手动创建。**
|
||||
|
|
@ -363,6 +459,7 @@ top: 9999
|
|||
...
|
||||
...
|
||||
```
|
||||
|
||||
3. 在主题配置文件启用 `about` 导航菜单。
|
||||
```yml
|
||||
# navigation menu
|
||||
|
|
@ -377,6 +474,10 @@ top: 9999
|
|||
|
||||
其他页面的生成方式跟「关于」页面类似，此处不再赘述。
|
||||
|
||||
## Contribution 贡献
|
||||
|
||||
欢迎各种形式的贡献，包括但不限于：美化样式、增加功能、改进代码、 修复 Bug 等。
|
||||
|
||||
## Feedback 反馈
|
||||
|
||||
在使用该主题过程中，如果遇到问题，请仔细阅读使用文档，或者给作者提 `Issue`。
|
||||
|
|
|
|||
Loading…
Reference in New Issue