92 lines
3.0 KiB
Markdown
92 lines
3.0 KiB
Markdown
<div align="right">
|
||
语言:
|
||
中文
|
||
<a title="Chinese" href="../../README.md">English</a>
|
||
</div>
|
||
|
||
# Keep
|
||
|
||
> «Keep» 是一款简约优雅的 [Hexo](https://hexo.io) 主题。它能让你专注于写作。
|
||
|
||
[![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)
|
||
[![License](https://img.shields.io/badge/license-%20MIT-orange?style=flat-square&logo=gnu)](https://github.com/XPoet/hexo-theme-keep/blob/master/LICENSE.md)
|
||
[![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/)**
|
||
|
||
|
||
## :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` 设置为 `next`。
|
||
|
||
```yml
|
||
theme: keep
|
||
```
|
||
|
||
## :wrench: 配置
|
||
|
||
参考 [Keep 主题配置指南](https://keep.xpoet.cn/2020/10/Keep-主题配置指南/)。
|
||
|
||
不推荐直接修改 «Keep» 主题的文件。因为这可能导致错误(例如 git merge 冲突),并且在升级主题时修改的文件可能丢失。
|
||
|
||
然而你也可以通过提交(`Commit`)、贮藏(`Stash`)或忽视(`Discard`)本地更改以绕过这种更新错误(例如 **«Commit your changes or stash them before you can merge»**)。具体方法请参考[这里](https://stackoverflow.com/a/15745424/5861495)。
|
||
|
||
## :dart: 更新
|
||
|
||
«Keep» 不定期发布新版本。你可以通过如下命令更新 «Keep»。
|
||
|
||
通过 npm 安装最新版本:
|
||
|
||
```sh
|
||
$ cd hexo-site
|
||
$ npm update hexo-theme-keep
|
||
```
|
||
|
||
或者通过 git 更新到最新的 master 分支:
|
||
|
||
```sh
|
||
$ cd themes/keep
|
||
$ git pull
|
||
```
|
||
|
||
## :art: 贡献
|
||
|
||
我们欢迎你加入 «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=980">
|
||
</a>
|
||
|
||
## :sparkling_heart: 鸣谢
|
||
|
||
«Keep» 特别感谢这些支持我们核心基础设施的优质服务:
|
||
|
||
<a href="https://github.com"><img height="40" src="https://github.githubassets.com/images/modules/logos_page/GitHub-Logo.png"></a>
|
||
|
||
> GitHub 容许我们托管 Git 仓库及运行测试。
|
||
|
||
<a href="https://www.jsdelivr.com"><img height="40" src="https://raw.githubusercontent.com/jsdelivr/jsdelivr-media/master/default/svg/jsdelivr-logo-horizontal.svg"></a>
|
||
|
||
> jsDelivr 提供了 CDN 服务。
|