# hexo-theme-keep
«Keep» is a simple and elegant [Hexo](https://hexo.io) theme. It makes you more focused on writing.
[](https://github.com/XPoet/hexo-theme-ils/blob/master/LICENSE)
[](https://github.com/XPoet/hexo-theme-ils/releases)
[](https://www.npmjs.com/package/hexo-theme-keep)
[](https://hexo.io)
[](https://hexo.io)
[](https://www.jsdelivr.com/package/npm/hexo-theme-keep)
## :star2: Online Preview
- **[XPoet's Blog](https://xpoet.cn/)**
- **[Keep demo website](https://keep.xpoet.cn/)**
> If you want to put a link to your blog in the online preview list, you can give the author a PR.
## :rocket: Installation
If you're using Hexo 5.0 or later, the simplest way to install is through npm:
```sh
# recommend
$ cd hexo-site
$ npm install hexo-theme-keep
```
Or you can clone the entire repository:
```sh
$ cd hexo-site
$ git clone https://github.com/XPoet/hexo-theme-keep themes/keep
```
After the installation, open Hexo config file and set `theme` variable to `keep`.
```yml
theme: keep
```
## :wrench: Usage
Please see the official documents of «Keep».
- **[Keep official document](https://keep-docs.xpoet.cn/)**
- **[Keep theme configuration guide](https://keep-docs.xpoet.cn/usage-tutorial/configuration-guide.html)**
- **[Keep theme advanced usage](https://keep-docs.xpoet.cn/usage-tutorial/advanced.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
«Keep» releases new versions from time to time. You can update Keep by the following command.
Install the latest version throuth npm:
```sh
# recommend
$ cd hexo-site
$ npm update hexo-theme-keep
```
Or update to latest master branch:
```sh
$ cd themes/keep
$ git pull
```
## :art: Contributing
We welcome you to join the development of «Keep». Please see [contributing guide](https://keep.xpoet.cn/2020/11/Keep-代码贡献指南/).
## :clapper: Contributors
This project exists thanks to all the people who contribute.
## :sparkling_heart: Thanks
«Keep» send special thanks to these great services that sponsor our core infrastructure:
> GitHub allows us to host the Git repository and run the test suite.
> Thanks jsDelivr and UNPKG for providing public CDN service.
## :memo: License
[GPL-3.0](https://github.com/XPoet/hexo-theme-keep/blob/master/LICENSE) Copyright © 2020-present XPoet