From 85e8c19fc78b7a69eff960c917a34ae0fae3ed96 Mon Sep 17 00:00:00 2001 From: liuyib <1656081615@qq.com> Date: Fri, 13 Mar 2020 11:53:34 +0800 Subject: [PATCH] docs: Update README & doc --- README.md | 34 ++++++++++++------------- README_en_US.md | 26 +++++++++---------- docs/zh-CN/advanced/advanced-setting.md | 4 +-- 3 files changed, 32 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 32c4b35..02bf006 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
-
@@ -17,7 +17,7 @@
-
+
@@ -29,23 +29,23 @@
## :sparkles: 演示
- [Liuyib's Blog](https://liuyib.github.io/)
-- [弥枳's Blog](https://blog.coor.top/)
+- [弥枳's Blog](http://blog2.coor.top/)
- [轻尘's Blog](http://qcxitong.xyz/)
如果你正在使用 stun 主题,并希望像上面一样,在这里展示出来,你可以通过 [PR](https://github.com/liuyib/hexo-theme-stun/pulls) 将你的网站链接填写在这里。
## :crystal_ball: 特性
-- 简洁,快速,易用,可定制性高
+- 简洁 & 快速 & 易用 & **可定制性高**
- 响应式设计
-- 二级导航菜单
-- 支持文章图片懒加载
-- 支持 [pjax](https://github.com/defunkt/jquery-pjax)
+- [二级导航菜单](https://liuyib.github.io/hexo-theme-stun/zh-CN/advanced/advanced-setting.html#二级导航菜单)
+- 支持[图片懒加载](https://liuyib.github.io/hexo-theme-stun/zh-CN/advanced/advanced-setting.html#图片懒加载)
+- 支持 [Pjax](https://github.com/defunkt/jquery-pjax)
- 支持 [PWA](https://developers.google.com/web/progressive-web-apps)
-- 支持 [fancybox](https://github.com/fancyapps/fancybox)
-- 支持 [quicklink](https://github.com/GoogleChromeLabs/quicklink)
+- 支持 [Fancybox](https://github.com/fancyapps/fancybox)
+- 支持 [Quicklink](https://github.com/GoogleChromeLabs/quicklink)
- 支持 [MathJax](https://www.mathjax.org/)、[KaTex](https://katex.org/)
-- 支持 [Gitalk](https://github.com/gitalk/gitalk)、[Valine](https://valine.js.org/)、[Livere](https://livere.com/)、[Disqus](https://disqus.com/) 和 [Utterances](https://github.com/utterance/utterances) 评论
+- 支持 [Gitalk](https://github.com/gitalk/gitalk)、[Valine](https://valine.js.org/)、[Livere](https://livere.com/)、[Disqus](https://disqus.com/)、[Utterances](https://github.com/utterance/utterances) 评论
- 瀑布流式的[相册页面](https://liuyib.github.io/gallery/)
- 内置[谷歌广告](https://www.google.cn/adsense/start/),一键开启
- 代码高亮,[多种配色](https://liuyib.github.io/hexo-theme-stun/zh-CN/advanced/advanced-setting.html#代码高亮)可选
@@ -54,31 +54,31 @@
## :package: 安装
-- 安装 stun
+- 安装 Stun
- 进入 hexo 根目录,执行指令。
+ 进入 Hexo 根目录,执行指令:
```bash
$ git clone https://github.com/liuyib/hexo-theme-stun.git themes/stun
```
-- 安装依赖 pug
+- 安装依赖 `hexo-renderer-pug`
- 进入 hexo 根目录,执行指令。
+ 进入 Hexo 根目录,执行指令:
```bash
- $ npm install --save hexo-render-pug
+ $ npm install --save hexo-renderer-pug
```
## :hammer: 使用
-修改 hexo 根目录下的 `_config.yml` 文件。
+修改 Hexo 根目录下的 `_config.yml` 文件:
```yml
theme: stun
```
-然后,启动 hexo 服务器。
+然后,启动 Hexo 服务器:
```bash
$ hexo clean && hexo s
diff --git a/README_en_US.md b/README_en_US.md
index fb27c8d..02a996b 100644
--- a/README_en_US.md
+++ b/README_en_US.md
@@ -29,23 +29,23 @@
## :sparkles: Demo
- [Liuyib's Blog](https://liuyib.github.io/)
-- [mizhi's Blog](https://blog.coor.top/)
-- [轻尘's Blog](https://blog.coor.top/)
+- [mizhi's Blog](http://blog2.coor.top/)
+- [轻尘's Blog](http://qcxitong.xyz/)
If you are using the stun theme and would like it to be shown here, you can fill in your website link by [PR](https://github.com/liuyib/hexo-theme-stun/pulls).
## :crystal_ball: Feature
-- Simple, fast, easy to use, highly customizable
+- Simple & Fast & Easy to Use & **Highly Customizable**
- Responsive design
-- Secondary navigation menu
-- Support article image lazy loading
+- [Secondary navigation menu](https://liuyib.github.io/hexo-theme-stun/zh-CN/advanced/advanced-setting.html#二级导航菜单)
+- Support [image lazy loading](https://liuyib.github.io/hexo-theme-stun/zh-CN/advanced/advanced-setting.html#图片懒加载)
- Support [Pjax](https://github.com/defunkt/jquery-pjax)
- Support [PWA](https://developers.google.com/web/progressive-web-apps)
- Support [Fancybox](https://github.com/fancyapps/fancybox)
- Support [Quicklink](https://github.com/GoogleChromeLabs/quicklink)
- Support [MathJax](https://www.mathjax.org/)、[KaTex](https://katex.org/)
-- Support [Gitalk](https://github.com/gitalk/gitalk)、[Valine](https://valine.js.org/)、[Livere](https://livere.com/)、[Disqus](https://disqus.com/) and [Utterances](https://github.com/utterance/utterances) comments
+- Support [Gitalk](https://github.com/gitalk/gitalk)、[Valine](https://valine.js.org/)、[Livere](https://livere.com/)、[Disqus](https://disqus.com/)、[Utterances](https://github.com/utterance/utterances) comments
- [Album page](https://liuyib.github.io/gallery/) of waterfall streaming
- Built-in [Google ads](https://www.google.cn/adsense/start/)
- Multiple code [highlighting themes](https://liuyib.github.io/hexo-theme-stun/zh-CN/advanced/advanced-setting.html#代码高亮)
@@ -54,31 +54,31 @@ If you are using the stun theme and would like it to be shown here, you can fill
## :package: Install
-- Install `stun`
+- Install `Stun`
- Enter your hexo directory, run this.
+ Enter your hexo directory, run this:
```bash
$ git clone https://github.com/liuyib/hexo-theme-stun.git themes/stun
```
-- Install dependency `pug`
+- Install dependency `hexo-renderer-pug`
- Enter your hexo directory, run this.
+ Enter your hexo directory, run this:
```bash
- $ npm install --save hexo-render-pug
+ $ npm install --save hexo-renderer-pug
```
## :hammer: Usage
-Change the `_config.yml` file in your hexo root directory.
+Change the `_config.yml` file in your hexo root directory:
```yml
theme: stun
```
-Run your hexo server.
+Run your hexo server:
```bash
$ hexo clean && hexo s
diff --git a/docs/zh-CN/advanced/advanced-setting.md b/docs/zh-CN/advanced/advanced-setting.md
index e67393f..9ffe173 100644
--- a/docs/zh-CN/advanced/advanced-setting.md
+++ b/docs/zh-CN/advanced/advanced-setting.md
@@ -325,9 +325,9 @@ Hexo 会使用 git commit 中,文件的最新提交时间作为更新日期,
是否解析文章中的 emoji 代码。详情:[添加-emoji-支持](https://liuyib.github.io/hexo-theme-stun/zh-CN/advanced/third-part.html#添加-emoji-支持)
-## 二级导航栏菜单