Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/xpoet/hexo-theme-keep

:rainbow: A simple and light theme for Hexo. It makes you more focused on writing.
https://github.com/xpoet/hexo-theme-keep

beautiful-theme hexo hexo-theme hexo-theme-keep simple-theme theme theme-keep

Last synced: 29 days ago
JSON representation

:rainbow: A simple and light theme for Hexo. It makes you more focused on writing.

Awesome Lists containing this project

README

        


Language:
English |
简体中文 |
繁體中文

Keep

# hexo-theme-keep

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

[![Github License](https://img.shields.io/github/license/XPoet/hexo-theme-keep?style=flat-square&logo=github&color=3366cc)](https://github.com/XPoet/hexo-theme-keep/blob/master/LICENSE)
[![Github Release](https://img.shields.io/github/release/XPoet/hexo-theme-keep?style=flat-square&logo=github&color=mediumpurple)](https://github.com/XPoet/hexo-theme-ils/releases)
[![NPM Version](https://img.shields.io/npm/v/hexo-theme-keep?style=flat-square&logo=npm&color=indianred)](https://www.npmjs.com/package/hexo-theme-keep)
[![NPM Downloads](https://img.shields.io/npm/dw/hexo-theme-keep?style=flat-square&logo=npm&color=darkorange)](https://www.npmjs.com/package/hexo-theme-keep)
[![Node.js Version](https://img.shields.io/badge/node-%3E=14.0.0-forestgreen?style=flat-square&logo=Node.js)](https://nodejs.org)
[![Required Hexo version](https://img.shields.io/badge/hexo-%3E=5.0.0-steelblue?style=flat-square&logo=hexo)](https://hexo.io)

## :star2: Online Preview

- **[XPoet's Blog](https://xpoet.cn/)**
- **[Keep Demo](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.

## :books: Documents

Please see the official documents of **Keep**.

- **[Keep official document](https://keep-docs.xpoet.cn/)**
- **[Keep theme configuration guide](https://keep-docs.xpoet.cn/basis/configuration-guide/base_info.html)**
- **[Keep theme advanced usage](https://keep-docs.xpoet.cn/advanced/set-language.html)**

## :rocket: Installation

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

```sh
# recommend

cd your-hexo
npm install hexo-theme-keep
```

Or you can clone the entire repository:

```sh
cd your-hexo
git clone https://github.com/XPoet/hexo-theme-keep --depth=1 themes/keep
```

After the installation, open Hexo config file and set `theme` variable to `keep`.

```yml
theme: keep
```

## :tada: Update

**Keep** releases new versions from time to time. You can update **Keep** by the following command.

Install the latest version through NPM:

```sh
# recommend

cd your-hexo
npm install hexo-theme-keep@latest
```

Or update to the latest master branch:

```sh
cd themes/keep
git pull
```

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.

## :art: Contributors

This project exists thanks to all the people who contribute.



We welcome you to join the development of **Keep**. Please see [contributing guide](https://keep-docs.xpoet.cn/user-notice/contribution-guide.html).

## :sparkling_heart: Thanks

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

- [GitHub](https://github.com) allows us to host the Git repository and run the test suite.
- Thanks [cdnjs](https://cdnjs.com), [jsDelivr](https://www.jsdelivr.com) and [UNPKG](https://www.unpkg.com) for providing public CDN service.

## :memo: License

[AGPL-3.0](https://github.com/XPoet/hexo-theme-keep/blob/master/LICENSE)

Copyright © 2020-present XPoet