2020-11-20 12:02:22 +08:00
< div align = "right" >
Language:
English
2020-11-20 15:36:26 +08:00
< a title = "Chinese" href = "docs/README_zh-CN.md" > 中文< / a >
2020-11-20 12:02:22 +08:00
< / div >
2020-03-12 19:35:27 +08:00
2020-11-20 12:02:22 +08:00
# Keep
2020-03-12 19:35:27 +08:00
2020-11-20 12:02:22 +08:00
> «Keep» is a simple and elegant [Hexo](https://hexo.io) theme. It makes you more focused on writing.
2020-05-17 17:35:48 +08:00
2020-11-20 12:02:22 +08:00
[](https://www.npmjs.com/package/hexo-theme-keep)
[](https://hexo.io)
[](https://github.com/XPoet/hexo-theme-keep/blob/master/LICENSE.md)
[](https://www.jsdelivr.com/package/npm/hexo-theme-keep)
2020-03-26 14:55:19 +08:00
2020-11-20 12:02:22 +08:00
## :star2: Live Preview
2020-05-17 17:35:48 +08:00
2020-11-20 15:36:26 +08:00
- **[XPoet's Blog](https://xpoet.cn/)**
- **[keep official website](https://keep.xpoet.cn/)**
2020-05-17 17:35:48 +08:00
2020-11-20 12:02:22 +08:00
## :rocket: Installation
2020-05-26 23:32:38 +08:00
2020-11-20 12:02:22 +08:00
If you're using Hexo 5.0 or later, the simplest way to install is through npm:
2020-05-17 17:35:48 +08:00
2020-11-20 12:02:22 +08:00
```sh
$ cd hexo-site
$ npm install hexo-theme-keep
2020-09-01 18:31:43 +08:00
```
2020-04-08 17:30:05 +08:00
2020-11-20 12:02:22 +08:00
Or you can clone the entire repository:
2020-04-15 09:29:19 +08:00
2020-11-20 12:02:22 +08:00
```sh
$ cd hexo-site
$ git clone https://github.com/XPoet/hexo-theme-keep themes/keep
```
2020-11-17 18:52:41 +08:00
2020-11-20 12:02:22 +08:00
After the installation, open Hexo config file and set `theme` variable to `keep` .
2020-09-11 15:58:10 +08:00
2020-04-08 17:30:05 +08:00
```yml
2020-11-20 12:02:22 +08:00
theme: keep
2020-04-08 17:30:05 +08:00
```
2020-03-12 19:35:27 +08:00
2020-11-20 12:02:22 +08:00
## :wrench: Configuration
2020-04-15 09:29:19 +08:00
2020-11-20 15:36:26 +08:00
Refer to the [Keep theme configuration guide ](https://keep.xpoet.cn/2020/11/Keep-主题配置指南/ ).
2020-04-15 09:57:24 +08:00
2020-11-20 12:02:22 +08:00
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.
2020-04-15 09:29:19 +08:00
2020-11-20 12:02:22 +08:00
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.
2020-04-15 09:57:24 +08:00
2020-11-20 12:02:22 +08:00
## :dart: Update
2020-04-15 09:29:19 +08:00
2020-11-20 12:02:22 +08:00
«Keep» releases new versions from time to time. You can update Keep by the following command.
2020-04-15 09:29:19 +08:00
2020-11-20 12:02:22 +08:00
Install the latest version throuth npm:
2020-04-15 09:57:24 +08:00
2020-11-20 12:02:22 +08:00
```sh
$ cd hexo-site
$ npm update hexo-theme-keep
2020-04-15 09:29:19 +08:00
```
2020-11-20 12:02:22 +08:00
Or update to latest master branch:
2020-09-11 15:58:10 +08:00
2020-11-20 12:02:22 +08:00
```sh
$ cd themes/keep
$ git pull
```
2020-09-14 16:37:38 +08:00
2020-11-20 12:02:22 +08:00
## :art: Contributing
2020-09-14 16:37:38 +08:00
2020-11-20 12:02:22 +08:00
We welcome you to join the development of «Keep». Please see [contributing guide ](https://keep.xpoet.cn/2020/11/Keep-代码贡献指南/ ). 🤗
2020-09-14 16:37:38 +08:00
2020-11-20 12:02:22 +08:00
## :clapper: Contributors
2020-09-14 16:37:38 +08:00
2020-11-20 12:02:22 +08:00
This project exists thanks to all the people who contribute.
2020-09-14 16:37:38 +08:00
2020-11-20 12:02:22 +08:00
< a href = "https://github.com/XPoet/hexo-theme-keep/graphs/contributors" >
< img src = "https://opencollective.com/hexo-theme-keep/contributors.svg?width=980" >
< / a >
2020-09-11 15:58:10 +08:00
2020-11-20 12:02:22 +08:00
## :sparkling_heart: Thanks
2020-09-11 15:58:10 +08:00
2020-11-20 12:02:22 +08:00
«Keep» send special thanks to these great services that sponsor our core infrastructure:
2020-11-17 23:17:32 +08:00
2020-11-20 12:02:22 +08:00
< a href = "https://github.com" > < img height = "40" src = "https://github.githubassets.com/images/modules/logos_page/GitHub-Logo.png" > < / a >
2020-04-15 09:29:19 +08:00
2020-11-20 12:02:22 +08:00
> GitHub allows us to host the Git repository and run the test suite.
2020-03-12 19:35:27 +08:00
2020-11-20 12:02:22 +08:00
< a href = "https://www.jsdelivr.com" > < img height = "40" src = "https://raw.githubusercontent.com/jsdelivr/jsdelivr-media/master/default/svg/jsdelivr-logo-horizontal.svg" > < / a >
2020-04-15 09:29:19 +08:00
2020-11-20 12:02:22 +08:00
> Thanks jsDelivr for providing public CDN service.
