2020-11-20 12:02:22 +08:00
< div align = "right" >
Language:
English
2021-06-20 12:01:07 +08:00
< a title = "Chinese" href = "README_zh-CN.md" > 简中< / a >
< a title = "Chinese" href = "README_zh-TW.md" > 繁中< / a >
2020-11-20 12:02:22 +08:00
< / div >
2020-03-12 19:35:27 +08:00
2021-01-12 15:37:30 +08:00
< a href = "https://xpoet.cn" > < img align = "center" alt = "Keep" src = "https://cdn.jsdelivr.net/gh/XPoet/image-hosting@master/hexo-theme-keep/keep-logo-slogan.svg" > < / a >
2020-11-20 18:18:56 +08:00
2021-01-05 16:34:33 +08:00
# hexo-theme-keep
2020-03-12 19:35:27 +08:00
2020-11-26 09:24:53 +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-24 10:53:19 +08:00
[](https://github.com/XPoet/hexo-theme-ils/blob/master/LICENSE)
[](https://github.com/XPoet/hexo-theme-ils/releases)
2020-11-20 12:02:22 +08:00
[](https://www.npmjs.com/package/hexo-theme-keep)
[](https://hexo.io)
2020-11-24 10:53:19 +08:00
[](https://hexo.io)
2020-11-20 12:02:22 +08:00
[](https://www.jsdelivr.com/package/npm/hexo-theme-keep)
2020-03-26 14:55:19 +08:00
2020-11-26 09:24:53 +08:00
## :star2: Online Preview
2020-05-17 17:35:48 +08:00
2020-11-20 15:36:26 +08:00
- **[XPoet's Blog](https://xpoet.cn/)**
2021-03-01 10:32:04 +08:00
- **[Keep demo website](https://keep.xpoet.cn/)**
- **[Keep official document](https://keep-docs.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-12-10 12:23:30 +08:00
## :wrench: Usage
2020-04-15 09:29:19 +08:00
2021-03-01 10:32:04 +08:00
Please see the official documents of «Keep».
2020-04-15 09:57:24 +08:00
2021-03-01 10:32:04 +08:00
- **[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)**
2020-04-15 09:29:19 +08:00
2020-12-10 12:23:30 +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: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
2021-04-29 11:48:45 +08:00
$ git pull
```
_If you modified theme source code:_
```sh
2021-03-07 10:12:44 +08:00
$ git add .
$ git stash
2020-11-20 12:02:22 +08:00
$ git pull
2021-03-07 10:12:44 +08:00
$ git stash pop
2020-11-20 12:02:22 +08:00
```
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-12-01 16:54:34 +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" >
2020-11-26 09:24:53 +08:00
< img src = "https://opencollective.com/hexo-theme-keep/contributors.svg?width=880" >
2020-11-20 12:02:22 +08:00
< / 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-26 09:24:53 +08:00
< a href = "https://github.com" > < img height = "38" src = "https://cdn.jsdelivr.net/gh/XPoet/image-hosting@master/hexo-theme-keep/GitHub-LOGO.5sq0168mirg0.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-26 09:24:53 +08:00
< a href = "https://www.jsdelivr.com" > < img height = "38" src = "https://cdn.jsdelivr.net/gh/XPoet/image-hosting@master/hexo-theme-keep/jsDelivr-LOGO.png" > < / a >
2020-04-15 09:29:19 +08:00
2020-11-20 12:02:22 +08:00
> Thanks jsDelivr for providing public CDN service.
2021-01-05 16:34:33 +08:00
## :memo: License
2021-06-20 12:01:07 +08:00
[MIT ](https://github.com/XPoet/picx/blob/master/LICENSE ) Copyright © 2020-2021 XPoet
2021-01-05 16:34:33 +08:00
