hexo-theme-keep/README_zh-CN.md

<div align="right">
  语言:
  中文
  <a title="Chinese" href="README.md">English</a>
</div>

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

# hexo-theme-keep

«Keep» 是一款简约优雅的 [Hexo](https://hexo.io) 主题。它能让你更专注于写作。

[![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: 在线预览

- **[XPoet's Blog](https://xpoet.cn/)**
- **[keep 演示网站](https://keep.xpoet.cn/)**
- **[keep 官方文档](https://keep-docs.xpoet.cn/)**

## :rocket: 安装

如果你在使用 Hexo 5.0 或更高版本，最简单的安装方式是通过 npm：

```sh
$ cd hexo-site
$ npm install hexo-theme-keep
```

你也可以直接克隆整个仓库：

```sh
$ cd hexo-site
$ git clone https://github.com/XPoet/hexo-theme-keep themes/keep
```

安装完成后，在 Hexo 配置文件中将 `theme` 设置为 `keep`。

```yml
theme: keep
```

## :wrench: 使用

请查看 «Keep» 官方文档：

- **[Keep 官方文档](https://keep-docs.xpoet.cn/)**
- **[Keep 主题配置指南](https://keep-docs.xpoet.cn/usage-tutorial/configuration-guide.html)**
- **[Keep 主题进阶使用](https://keep-docs.xpoet.cn/usage-tutorial/advanced.html)**

不推荐直接修改 «Keep» 主题的文件。因为这可能导致错误（例如 git merge 冲突），并且在升级主题时修改的文件可能丢失。

## :dart: 更新

«Keep» 不定期发布新版本。你可以通过如下命令更新 «Keep»。

通过 npm 安装最新版本：

```sh
$ cd hexo-site
$ npm update hexo-theme-keep
```

或者通过 git 更新到最新的 master 分支：

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

_如果你修改了主题源码：_

```sh
$ git add .
$ git stash
$ git pull
$ git stash pop
```

## :art: 贡献

我们欢迎你加入 «Keep» 的开发，贡献出你的一份力量。请看[Keep 代码贡献指南](https://keep.xpoet.cn/2020/11/Keep-代码贡献指南/)。

## :clapper: 贡献者

这个项目的存在多亏了所有的贡献者。

<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: 鸣谢

«Keep» 特别感谢这些支持我们核心基础设施的优质服务：

<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 容许我们托管 Git 仓库及运行测试。

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

> jsDelivr 提供了 CDN 服务。

## :memo: 许可

[MIT](https://github.com/XPoet/picx/blob/master/LICENSE) Copyright © 2020 XPoet