docs: update README
This commit is contained in:
parent
e454d7f79a
commit
aa396b1735
10
README.md
10
README.md
|
@ -45,14 +45,16 @@ After the installation, open Hexo config file and set `theme` variable to `keep`
|
|||
theme: keep
|
||||
```
|
||||
|
||||
## :wrench: Configuration
|
||||
## :wrench: Usage
|
||||
|
||||
Refer to the [Keep theme configuration guide](https://keep.xpoet.cn/2020/11/Keep-主题配置指南/).
|
||||
See docs:
|
||||
|
||||
- [Keep theme usage guide](https://keep.xpoet.cn/2020/04/Keep-主题使用指南/).
|
||||
|
||||
- [Keep theme configuration guide](https://keep.xpoet.cn/2020/11/Keep-主题配置指南/).
|
||||
|
||||
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.
|
||||
|
||||
However, you can bypass merge conflicts (error message like **«Commit your changes or stash them before you can merge»**) by using the `Commit`, `Stash` or `Reset` commands for local changes. See [here](https://stackoverflow.com/a/15745424/5861495) how to do it.
|
||||
|
||||
## :dart: Update
|
||||
|
||||
«Keep» releases new versions from time to time. You can update Keep by the following command.
|
||||
|
|
|
@ -45,14 +45,16 @@ $ git clone https://github.com/XPoet/hexo-theme-keep themes/keep
|
|||
theme: keep
|
||||
```
|
||||
|
||||
## :wrench: 配置
|
||||
## :wrench: 使用
|
||||
|
||||
参考 [Keep 主题配置指南](https://keep.xpoet.cn/2020/11/Keep-主题配置指南/)。
|
||||
查看文档:
|
||||
|
||||
- [Keep 主题使用指南](https://keep.xpoet.cn/2020/04/Keep-主题使用指南/).
|
||||
|
||||
- [Keep 主题配置指南](https://keep.xpoet.cn/2020/11/Keep-主题配置指南/).
|
||||
|
||||
不推荐直接修改 «Keep» 主题的文件。因为这可能导致错误(例如 git merge 冲突),并且在升级主题时修改的文件可能丢失。
|
||||
|
||||
然而你也可以通过提交(`Commit`)、贮藏(`Stash`)或忽视(`Discard`)本地更改以绕过这种更新错误(例如 **«Commit your changes or stash them before you can merge»**)。具体方法请参考[这里](https://stackoverflow.com/a/15745424/5861495)。
|
||||
|
||||
## :dart: 更新
|
||||
|
||||
«Keep» 不定期发布新版本。你可以通过如下命令更新 «Keep»。
|
||||
|
|
Loading…
Reference in New Issue