hexo-theme-keep/docs/README_zh-CN.md

102 lines
3.4 KiB
Markdown
Raw Normal View History

2020-11-20 12:02:22 +08:00
<div align="right">
语言:
中文
2020-11-26 09:35:13 +08:00
<a title="Chinese" href="../README.md">English</a>
2020-11-20 12:02:22 +08:00
</div>
2020-12-08 15:26:31 +08:00
<a href="https://xpoet.cn"><img align="center" alt="Keep logo" src="https://cdn.jsdelivr.net/gh/XPoet/image-hosting@master/hexo-theme-keep/keep-logo-desc.31muhob1mfi0.svg"></a>
2020-11-20 18:18:56 +08:00
2021-01-05 16:34:33 +08:00
# hexo-theme-keep
2020-11-20 12:02:22 +08:00
2020-11-26 09:24:53 +08:00
«Keep» 是一款简约优雅的 [Hexo](https://hexo.io) 主题。它能让你更专注于写作。
2020-11-20 12:02:22 +08:00
2020-12-08 11:04:52 +08:00
[![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)
2020-11-20 12:02:22 +08:00
[![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)
2020-12-08 11:04:52 +08:00
[![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)
2020-11-20 12:02:22 +08:00
[![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: 在线预览
2020-11-20 15:36:26 +08:00
- **[XPoet's Blog](https://xpoet.cn/)**
- **[keep 官网](https://keep.xpoet.cn/)**
2020-11-20 12:02:22 +08:00
## :rocket: 安装
2020-12-25 17:38:05 +08:00
如果你在使用 Hexo 5.0 或更高版本,最简单的安装方式是通过 npm
2020-11-20 12:02:22 +08:00
```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
```
2020-12-10 12:23:30 +08:00
## :wrench: 使用
2020-11-20 12:02:22 +08:00
2020-12-10 12:23:30 +08:00
查看文档:
2020-11-20 12:02:22 +08:00
2020-12-10 18:39:42 +08:00
- [Keep 主题使用指南](https://keep.xpoet.cn/2020/04/Keep-主题使用指南/)
2020-12-10 12:23:30 +08:00
2020-12-10 18:39:42 +08:00
- [Keep 主题配置指南](https://keep.xpoet.cn/2020/11/Keep-主题配置指南/)
2020-11-20 12:02:22 +08:00
2020-12-10 12:23:30 +08:00
不推荐直接修改 «Keep» 主题的文件。因为这可能导致错误(例如 git merge 冲突),并且在升级主题时修改的文件可能丢失。
2020-11-20 12:02:22 +08:00
## :dart: 更新
«Keep» 不定期发布新版本。你可以通过如下命令更新 «Keep»。
通过 npm 安装最新版本:
```sh
$ cd hexo-site
$ npm update hexo-theme-keep
```
或者通过 git 更新到最新的 master 分支:
```sh
$ cd themes/keep
$ git pull
```
## :art: 贡献
2020-12-01 16:54:34 +08:00
我们欢迎你加入 «Keep» 的开发,贡献出你的一份力量。请看[Keep 代码贡献指南](https://keep.xpoet.cn/2020/11/Keep-代码贡献指南/)。
2020-11-20 12:02:22 +08:00
## :clapper: 贡献者
这个项目的存在多亏了所有的贡献者。
<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>
## :sparkling_heart: 鸣谢
«Keep» 特别感谢这些支持我们核心基础设施的优质服务:
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-11-20 12:02:22 +08:00
> GitHub 容许我们托管 Git 仓库及运行测试。
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-11-20 12:02:22 +08:00
> jsDelivr 提供了 CDN 服务。
2021-01-05 16:34:33 +08:00
## :memo: 许可
[MIT](https://github.com/XPoet/picx/blob/master/LICENSE) Copyright © 2020 XPoet