docs: update documents

XPoet · Nov 24, 2023 · 88985c2 · 88985c2
1 parent c353cec
commit 88985c2
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 43 deletions.
diff --git a/README.md b/README.md
@@ -32,15 +32,15 @@ If you're using Hexo 5.0 or later, the simplest way to install is through NPM:
 ```sh
 # recommend
 
-$ cd your-hexo
-$ npm install hexo-theme-keep
+cd your-hexo
+npm install hexo-theme-keep
 ```
 
 Or you can clone the entire repository:
 
 ```sh
-$ cd your-hexo
-$ git clone https://github.com/XPoet/hexo-theme-keep themes/keep
+cd your-hexo
+git clone https://github.com/XPoet/hexo-theme-keep --depth=1 themes/keep
 ```
 
 After the installation, open Hexo config file and set `theme` variable to `keep`.
@@ -49,48 +49,46 @@ After the installation, open Hexo config file and set `theme` variable to `keep`
 theme: keep
 ```
 
-## :wrench: Usage
+## :books: Documents
 
 Please see the official documents of **Keep**.
 
 - **[Keep official document](https://keep-docs.xpoet.cn/)**
 - **[Keep theme configuration guide](https://keep-docs.xpoet.cn/basis/configuration-guide/base_info.html)**
 - **[Keep theme advanced usage](https://keep-docs.xpoet.cn/advanced/set-language.html)**
 
-It is not recommended to directly modify any files in the **Keep** theme. Because this may cause errors (e.g. merge conflicts), and the modified files may be discarded when upgrading the theme.
-
-## :dart: Update
+## :tada: Update
 
-**Keep** releases new versions from time to time. You can update Keep by the following command.
+**Keep** releases new versions from time to time. You can update **Keep** by the following command.
 
 Install the latest version through NPM:
 
 ```sh
 # recommend
 
-$ cd your-hexo
-$ npm install hexo-theme-keep@latest
+cd your-hexo
+npm install hexo-theme-keep@latest
 ```
 
 Or update to the latest master branch:
 
 ```sh
-$ cd themes/keep
-$ git pull
+cd themes/keep
+git pull
 ```
 
-## :art: Contributing
-
-We welcome you to join the development of **Keep**. Please see [contributing guide](https://keep-docs.xpoet.cn/user-notice/contribution-guide.html).
+It is not recommended to directly modify any files in the **Keep** theme. Because this may cause errors (e.g. merge conflicts), and the modified files may be discarded when upgrading the theme.
 
-## :clapper: Contributors
+## :art: Contributors
 
 This project exists thanks to all the people who contribute.
 
 <a href="https://github.com/XPoet/hexo-theme-keep/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=XPoet/hexo-theme-keep" />
 </a>
 
+We welcome you to join the development of **Keep**. Please see [contributing guide](https://keep-docs.xpoet.cn/user-notice/contribution-guide.html).
+
 ## :sparkling_heart: Thanks
 
 **Keep** send special thanks to these great services that sponsor our core infrastructure:

diff --git a/docs/README_zh-CN.md b/docs/README_zh-CN.md
@@ -26,20 +26,20 @@
 
 ## :rocket: 安装
 
-如果你在使用 Hexo 5.0 或更高版本，最简单的安装方式是通过 NPM：
+如果你使用 Hexo 5.0 或更高版本，最简单的安装方式是通过 NPM：
 
 ```sh
 # 推荐
 
-$ cd your-hexo
-$ npm install hexo-theme-keep
+cd your-hexo
+npm install hexo-theme-keep
 ```
 
 你也可以直接克隆整个仓库：
 
 ```sh
-$ cd your-hexo
-$ git clone https://github.com/XPoet/hexo-theme-keep --depth=1 themes/keep
+cd your-hexo
+git clone https://github.com/XPoet/hexo-theme-keep --depth=1 themes/keep
 ```
 
 安装完成后，在 Hexo 配置文件中将 `theme` 设置为 `keep`。
@@ -48,17 +48,15 @@ $ git clone https://github.com/XPoet/hexo-theme-keep --depth=1 themes/keep
 theme: keep
 ```
 
-## :wrench: 使用
+## :books: 文档
 
 请查看 **Keep** 官方文档：
 
 - **[Keep 官方文档](https://keep-docs.xpoet.cn/)**
 - **[Keep 主题配置指南](https://keep-docs.xpoet.cn/basis/configuration-guide/base_info.html)**
 - **[Keep 主题进阶使用](https://keep-docs.xpoet.cn/advanced/set-language.html)**
 
-不推荐直接修改 **Keep** 主题的文件。因为这可能导致错误（例如 git merge 冲突），并且在升级主题时修改的文件可能丢失。
-
-## :dart: 更新
+## :tada: 更新
 
 **Keep** 不定期发布新版本，你可以通过如下命令更新 **Keep**。
 
@@ -78,18 +76,18 @@ $ cd themes/keep
 $ git pull
 ```
 
-## :art: 贡献
+不推荐直接修改 **Keep** 主题的源文件。因为这可能导致错误（例如 git merge 冲突），并且在升级主题时修改的文件可能丢失。
 
-我们欢迎你加入 **Keep** 的开发，贡献出你的一份力量。请看 [Keep 代码贡献指南](https://keep-docs.xpoet.cn/user-notice/contribution-guide.html)。
-
-## :clapper: 贡献者
+## :art: 贡献者
 
 这个项目的存在多亏了所有的贡献者。
 
 <a href="https://github.com/XPoet/hexo-theme-keep/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=XPoet/hexo-theme-keep" />
 </a>
 
+我们欢迎你加入 **Keep** 的开发，贡献出你的一份力量。请看 [Keep 代码贡献指南](https://keep-docs.xpoet.cn/user-notice/contribution-guide.html)。
+
 ## :sparkling_heart: 鸣谢
 
 **Keep** 特别感谢这些支持我们核心基础设施的优质服务：

diff --git a/docs/README_zh-TW.md b/docs/README_zh-TW.md
@@ -27,20 +27,20 @@
 
 ## :rocket: 安装
 
-如果你在使用 Hexo 5.0 或更高版本，最簡單的安裝方式是透過 NPM：
+如果你使用 Hexo 5.0 或更高版本，最簡單的安裝方式是透過 NPM：
 
 ```sh
 # 推薦
 
-$ cd your-hexo
-$ npm install hexo-theme-keep
+cd your-hexo
+npm install hexo-theme-keep
 ```
 
 你也可以直接 clone 整個原始碼庫：
 
 ```sh
-$ cd your-hexo
-$ git clone https://github.com/XPoet/hexo-theme-keep --depth=1 themes/keep
+cd your-hexo
+git clone https://github.com/XPoet/hexo-theme-keep --depth=1 themes/keep
 ```
 
 安裝完成後，在 Hexo 配置文件中將 `theme` 設定為 `keep`。
@@ -49,17 +49,15 @@ $ git clone https://github.com/XPoet/hexo-theme-keep --depth=1 themes/keep
 theme: keep
 ```
 
-## :wrench: 使用
+## :books: 文檔
 
 請查看 **Keep** 官方文檔：
 
 - **[Keep 官方文檔](https://keep-docs.xpoet.cn/)**
 - **[Keep 主題配置指南](https://keep-docs.xpoet.cn/basis/configuration-guide/base_info.html)**
 - **[Keep 主題進階使用](https://keep-docs.xpoet.cn/advanced/set-language.html)**
 
-不推薦直接修改 **Keep** 主題的文件。因為這可能導致錯誤（例如 git merge 衝突），並且在更新主題時修改的文件可能丟失。
-
-## :dart: 更新
+## :tada: 更新
 
 **Keep** 不定期發布新版本。你可以透過如下命令更新 **Keep**。
 
@@ -79,18 +77,18 @@ $ cd themes/keep
 $ git pull
 ```
 
-## :art: 貢獻
-
-我們歡迎你加入 **Keep** 的開發，貢獻出你的一份力量。請看[Keep 原始碼貢獻指南](https://keep-docs.xpoet.cn/user-notice/contribution-guide.html)。
+不推薦直接修改 **Keep** 主題的文件。因為這可能導致錯誤（例如 git merge 衝突），並且在更新主題時修改的文件可能丟失。
 
-## :clapper: 貢獻者
+## :art: 貢獻者
 
 這個項目的存在多虧了所有的貢獻者。
 
 <a href="https://github.com/XPoet/hexo-theme-keep/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=XPoet/hexo-theme-keep" />
 </a>
 
+我們歡迎你加入 **Keep** 的開發，貢獻出你的一份力量。請看 [Keep 原始碼貢獻指南](https://keep-docs.xpoet.cn/user-notice/contribution-guide.html)。
+
 ## :sparkling_heart: 銘謝
 
 **Keep** 特别感謝這些支持我們核心基本設施的優質服務：