<div align="right">
  Language:
  English
  <a title="Chinese" href="docs/README_zh-CN.md">中文</a>
</div>

<a title="Keep website" href="https://xpoet.cn"><img align="right" alt="Keep logo" width="100" height="100" src="https://raw.githubusercontent.com/XPoet/hexo-theme-keep/master/source/images/logo.svg"></a>

# Keep
> old name `ILS`

«Keep» is a simple and elegant [Hexo](https://hexo.io) theme. It makes you more focused on writing.

[![Github License](https://img.shields.io/github/license/XPoet/hexo-theme-keep.svg?style=flat-square)](https://github.com/XPoet/hexo-theme-ils/blob/master/LICENSE)
[![Github Release](https://img.shields.io/github/release/XPoet/hexo-theme-keep.svg?style=flat-square)](https://github.com/XPoet/hexo-theme-ils/releases)
[![NPM version](https://img.shields.io/npm/v/hexo-theme-keep?color=red&logo=npm&style=flat-square)](https://www.npmjs.com/package/hexo-theme-keep)
[![Required Hexo version](https://img.shields.io/badge/hexo-%3E=5.0.0-blue?style=flat-square&logo=hexo)](https://hexo.io)
[![Node.js Version](https://img.shields.io/badge/node-%3E=12.0-success.svg?style=flat-square&logo=Node.js&longCache=true)](https://hexo.io)
[![jsDelivr hits](https://img.shields.io/jsdelivr/npm/hm/hexo-theme-keep?style=flat-square&logo=jsdelivr)](https://www.jsdelivr.com/package/npm/hexo-theme-keep)

## :star2: Online Preview

- **[XPoet's Blog](https://xpoet.cn/)**
- **[keep official website](https://keep.xpoet.cn/)**

## :rocket: Installation

If you're using Hexo 5.0 or later, the simplest way to install is through npm:

```sh
$ 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: Configuration

Refer to the [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.

Install the latest version throuth npm:

```sh
$ 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.

<a href="https://github.com/XPoet/hexo-theme-keep/graphs/contributors">
  <img src="https://opencollective.com/hexo-theme-keep/contributors.svg?width=880">
</a>

## :sparkling_heart: Thanks

«Keep» send special thanks to these great services that sponsor our core infrastructure:

<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>

> GitHub allows us to host the Git repository and run the test suite.

<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>

> Thanks jsDelivr for providing public CDN service.
