docs: update README

2020-09-01 18:31:43 +08:00 · 2020-09-01 18:31:43 +08:00 · e7c63b75c4
parent 2fa62e812c
commit e7c63b75c4
1 changed files with 77 additions and 55 deletions
--- a/README.md
+++ b/README.md
@ -3,8 +3,8 @@
 [![Github Author](https://img.shields.io/badge/author-XPoet-orange.svg)](https://github.com/XPoet)
 [![Github Release](https://img.shields.io/github/release/XPoet/hexo-theme-ils.svg)](https://github.com/XPoet/hexo-theme-ils/releases)
 [![Github License](https://img.shields.io/github/license/XPoet/hexo-theme-ils.svg)](https://github.com/XPoet/hexo-theme-ils/blob/master/LICENSE)
-[![Hexo Version](https://img.shields.io/badge/hexo-%3E=4.2.0-blue.svg?&logo=hexo&longCache=true)](https://hexo.io)
-[![Node.js Version](https://img.shields.io/badge/node-%3E=10.9.0-green.svg?logo=Node.js&longCache=true)](https://hexo.io)
+[![Hexo Version](https://img.shields.io/badge/hexo-%3E=4.2.0-blue.svg?&logo=hexo&longCache=true)](https://nodejs.org/)
+[![Node.js Version](https://img.shields.io/badge/node-%3E=12.0-green.svg?logo=Node.js&longCache=true)](https://hexo.io)

 **一款简约轻快的 Hexo 主题。**  
 **A simple and light theme for Hexo.**
@ -36,16 +36,20 @@
 </details>

 **Online Preview 在线预览**
-> 如果你在使用该主题，欢迎 PR 将站点链接放置此处。
+
+> 如果你在使用该主题，欢迎 [PR](https://juejin.im/post/6844903856971710477) 将你的网站链接填写在下方，获得更多展示机会。
+
 - [XPoet Blog](https://xpoet.cn)
 - ...
-***
+- ...
+
+---

 如你所见，ILS 界面设计十分简洁、清爽，但功能齐全、不失优雅，这正是 ILS 的开发理念。也曾尝试过花里胡哨，发现不仅容易审美疲劳，而且背驰了写博客的初衷，记录生活、展示文字，应该才是搭建博客网站的最终追求，为此 ILS 应运而生。简约大气、不缺美感、突出内容、化繁为简、配置简单、长期维护，如果你也喜欢或认可这些主题特点，一起来折腾吧~

 关于主题名称 **"ILS"** 的由来：在主题开发之初，作者想到的几个名字都被已被用，词穷了，后来干脆将名字取自 **"I Like Simple「我喜欢简单」"** 首字母，就是这么简单。

-同时，非常欢迎感兴趣的同学 Pull Request 加入到该主题的开发中，共同打造极致 ILS。
+同时，非常欢迎感兴趣的同学 [Pull Request](https://juejin.im/post/6844903856971710477) 加入到该主题的开发中（成为该项目的贡献者），按你的意愿来打磨 ILS。

 ## Features 功能特性

@ -64,11 +68,11 @@
 - [x] RSS 订阅。
 - [x] 网站 UV 和 PV 统计。
 - [x] 文章阅读次数统计。
+- [x] 文章字数统计。
+- [x] 文章阅读时长统计。
 - [x] 页面滚动百分比提示。
 - [x] 一键快速回到顶部。
 - [x] 无 jQuery，代码精简。
- [x] 文章字数统计
- [x] 文章阅读时长

 ### Unfinished 未完成

@ -86,17 +90,28 @@
 ### Install 安装

 - 使用 Git SSH
+
  ```bash
  git clone --depth=1 git@github.com:XPoet/hexo-theme-ils.git themes/ils
  ```
- 下载主题 release 版本  
-  请优先下载 [最新 release 版本](https://github.com/XPoet/hexo-theme-ils/releases)，master 分支无法保证稳定。  
-  下载后解压到 Hexo 博客目录下 themes 文件夹里面并重命名为 `ils`。
+
+  该方式获取的是 Master 分支最新代码，包含该主题最新的功能，但无法保证完全稳定。
+
+- 下载 Release 版本
+
+  [点击此处进入该主题 Releases 版本下载页面](https://github.com/XPoet/hexo-theme-ils/releases) 请优先下载最新版本，下载完成后解压到 Hexo 博客目录的 themes 文件夹里面并重命名为 `ils`。

 ### Enable 启用

 Modify `theme` setting in `_config.yml` to `ils`.  
-找到博客目录下的 `_config.yml` 文件，将 `theme` 设置为 `ils` 。
+修改博客目录下的 `_config.yml` 配置文件，将 `theme` 设置为 `ils` 。
+
+```yml
+# Extensions
+## Plugins: https://hexo.io/plugins/
+## Themes: https://hexo.io/themes/
+theme: ils
+```

 ### Update 更新

@ -105,8 +120,7 @@ Modify `theme` setting in `_config.yml` to `ils`.
  cd themes/ils
  git pull
  ```
- 下载 [主题最新 release 版本](https://github.com/XPoet/hexo-theme-ils/releases)  
-  下载后解压到 Hexo 博客目录下 themes 文件夹里面并重命名为 `ils`。
+- 下载 [主题最新 Release 版本](https://github.com/XPoet/hexo-theme-ils/releases) 。

 ## How to use 如何使用

@ -122,25 +136,27 @@ theme_info:
  repository: https://github.com/XPoet/hexo-theme-ils

 # favicon
-# 网站图标，请在 "/source/images/" 目录，换成自己的即可。
+# 网站图标，把 "/source/images/" 目录下的 "favicon.png"，换成自己的图片即可。
 favicon: images/favicon.png

 # avatar
-# 头像图片，请在 "/source/images/" 目录，换成自己的即可。
+# 头像图片，把 "/source/images/" 目录下的 "avatar.png"，换成自己的图片即可。
 avatar: images/avatar.png

 # navigation menu
 # 导航菜单，如需新增导航，请按下面格式填写，同时需要添加对应的 Hexo 页面。
-# 新增页面，请参考往下的教程："Add page 添加页面"。
+# 如何新增页面，请参考下面的教程："Add page 添加页面"。
 menu:
  Home: /
  Archives: /archives
+  # Categories: /categories
  # About: /about
  # Links: /links
  # ...

 # RSS
 # RSS 订阅，如需启用，请先安装 Hexo 插件：hexo-generator-feed。
+# 在博客根目录下使用 npm 命令安装: npm i hexo-generator-feed --save
 rss:
  enable: true

@ -148,16 +164,16 @@ rss:
 # 评论插件，主题内置了 Valine 和 Gitalk，只能使用其中一款，如果 enable 都设为了 true，将使用 Valine。
 comments:
  # Valine https://github.com/xCss/Valine
-  # 如何使用 Valine 请参考：https://github.com/xCss/Valine
+  # 如何使用 Valine 请参考官方教程：https://github.com/xCss/Valine
  valine:
    enable: false
    appid: # leancloud appid
    appkey: # leancloud appkey
-    meta: ['nick', 'mail', 'link']
+    meta: ["nick", "mail", "link"]
    placeholder: 😜尽情吐槽吧~

  # Gitalk https://github.com/gitalk/gitalk
-  # 如何使用 Gitalk 请参考：https://github.com/gitalk/gitalk
+  # 如何使用 Gitalk 请参考官方教程：https://github.com/gitalk/gitalk
  gitalk:
    enable: false
    github_id: # GitHub repo owner
@ -169,6 +185,10 @@ comments:
 # 网站计数
 website_count:
  # busuanzi http://ibruce.info/2015/04/04/busuanzi/
+  # 主题内置“不蒜子”计数，无需额外配置，只需选择开启想要的计数
+  # site_uv 访问人数计数
+  # site_pv 访问量计数
+  # page_pv 文章阅读量计数
  busuanzi_count:
    enable: false
    site_uv: false
@ -178,12 +198,11 @@ website_count:
 # Local Search
 # Dependencies: https://github.com/theme-next/hexo-generator-searchdb
 # 本地搜索，如需启用，请先安装 Hexo 插件：hexo-generator-searchdb。
+# 在博客根目录下使用 npm 命令安装: npm i hexo-generator-searchdb --save
 local_search:
  enable: true

-  # If auto, trigger search by changing input.
-  # If manual, trigger search by pressing enter key or search button.
-  # 输入关键字后的触发搜索，可选 自动 auto 或 手动 manual。
+  # trigger 搜索触发方式，输入关键字后会触发搜索，可选 auto（自动）或 manual（手动）。
  # auto 每输入或删除一个字符后，自动触发搜索。
  # manual 每输入或删除一个字符后，需要按回车键触发搜索。
  trigger: auto # values: auto | manual
@ -196,6 +215,13 @@ local_search:
  # 在页面加载时预加载搜索数据
  preload: true

+# 文章字数统计、阅读时长
+# 如需启用，请先安装 Hexo 插件：hexo-wordcount。
+# 在博客根目录下使用 npm 命令安装: npm i hexo-wordcount --save
+post_wordcount:
+  wordcount: true # 字数统计
+  min2read: true # 阅读时长
+
 # Code Copy
 # 代码复制，复制风格可选 default | flat | mac。
 code_copy:
@ -237,14 +263,6 @@ magic:
    enable: false # 是否显示侧边栏
    fixed: true # 侧边栏是否固定
    position: right # 侧边栏位置 values: left | right
-
-# 文章字数统计、阅读时长
-# 需要安装 https://github.com/willin/hexo-wordcount
-# npm i --save hexo-wordcount
-post_wordcount:
-  wordcount: true  # 字数统计
-  min2read: true   # 阅读时长
-
 ```

 ### Comment 评论
@ -318,12 +336,14 @@ top: 9999
 **Hexo 初始化没有 about、links、tag、category 等页面，需要自己手动创建。**  
 例如创建「关于」页面：

-1. 在 Hexo 博客目录下执行命令
+1. 在 Hexo 博客目录下执行命令，即可生成 `about` 文件夹。 
   ```bash
   hexo new page about
   ```
-2. 创建成功后，打开博客目录下 `/source/about/index.md` 文件，即可填写内容。  
-   如下示例：
+2. 创建成功后，打开博客目录下 `/source/about/index.md` 文件，即可填写自己的内容。
+   支持 Markdown 和 HTML 格式；`comments: true` 表示该页面开启评论功能。
+
+   参考如下示例：

   ```markdown
   ---
@ -331,7 +351,9 @@ top: 9999
   date: 2020-03-19 14:59:53
   comments: true
   ---
+
   ## About me
+
   - XPoet「 X 诗人 」...
     ...
     ...
@ -340,7 +362,7 @@ top: 9999

 ## Feedback 反馈

-在使用该主题过程中，如果遇到问题，请仔细阅读使用文档，或者给作者提 `issue`。
+在使用该主题过程中，如果遇到问题，请仔细阅读使用文档，或者给作者提 `Issue`。

 ## Licence 许可