Skip to content

Commit

Permalink
docs: update documents
Browse files Browse the repository at this point in the history
  • Loading branch information
XPoet committed Oct 12, 2023
1 parent c416bff commit c1b9caf
Show file tree
Hide file tree
Showing 4 changed files with 76 additions and 91 deletions.
43 changes: 19 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,41 +5,40 @@
<a title="Chinese" href="docs/README_zh-TW.md">繁體中文</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>
<a href="https://xpoet.cn"><img align="center" alt="Keep" src="https://xpoet.cn/images/keep-slogan.svg"></a>

# hexo-theme-keep

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

[![Author](https://img.shields.io/badge/author-XPoet-violet.svg?style=flat-square)](https://github.com/XPoet)
[![Github License](https://img.shields.io/github/license/XPoet/hexo-theme-keep.svg?style=flat-square&logo=github)](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&logo=github)](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=14.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)
[![Github License](https://img.shields.io/github/license/XPoet/hexo-theme-keep?style=for-the-badge&logo=github&color=3366CC)](https://github.com/XPoet/hexo-theme-keep/blob/master/LICENSE)
[![NPM version](https://img.shields.io/npm/v/hexo-theme-keep?style=for-the-badge&logo=npm&color=FF9999)](https://www.npmjs.com/package/hexo-theme-keep)
[![NPM Downloads](https://img.shields.io/npm/dw/hexo-theme-keep?style=for-the-badge&logo=npm&color=9966CC)](https://www.npmjs.com/package/hexo-theme-keep)
[![Node.js Version](https://img.shields.io/badge/node-%3E=14.0.0-009999?style=for-the-badge&logo=Node.js)](https://nodejs.org/)
[![Required Hexo version](https://img.shields.io/badge/hexo-%3E=5.0.0-99ccff?style=for-the-badge&logo=hexo)](https://hexo.io)

## :star2: Online Preview

- **[XPoet's Blog](https://xpoet.cn/)**
- **[Keep demo website](https://keep.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.
## :rocket: Installation

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

```sh
# recommend
$ cd hexo-site

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

Or you can clone the entire repository:

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

Expand All @@ -54,7 +53,7 @@ theme: keep
Please see the official documents of **Keep**.
- **[Keep official document](https://keep-docs.xpoet.cn/)**
- **[Keep theme configuration guide](https://keep-docs.xpoet.cn/tutorial/configuration-guide/base_info.html)**
- **[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)**
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.
Expand All @@ -63,11 +62,12 @@ It is not recommended to directly modify any files in the **Keep** theme. Becaus
**Keep** releases new versions from time to time. You can update Keep by the following command.
Install the latest version throuth npm:
Install the latest version through NPM:
```sh
# recommend
$ cd hexo-site

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

Expand All @@ -80,7 +80,7 @@ $ git pull

## :art: Contributing

We welcome you to join the development of **Keep**. Please see [contributing guide](https://keep.xpoet.cn/2020/11/Keep-代码贡献指南/).
We welcome you to join the development of **Keep**. Please see [contributing guide](https://keep-docs.xpoet.cn/user-notice/contribution-guide.html).

## :clapper: Contributors

Expand All @@ -94,13 +94,8 @@ This project exists thanks to all the people who contribute.

**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 and UNPKG for providing public CDN service.
- [GitHub](https://github.com) allows us to host the Git repository and run the test suite.
- Thanks [jsDelivr](https://www.jsdelivr.com) and [UNPKG](https://www.unpkg.com) for providing public CDN service.

## :memo: License

Expand Down
34 changes: 17 additions & 17 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

# ---------------------------------------------------------------------------------------
# Your basic info
# Docs: https://keep-docs.xpoet.cn/tutorial/configuration-guide/base_info.html
# Docs: https://keep-docs.xpoet.cn/basis/configuration-guide/base_info.html
# ---------------------------------------------------------------------------------------
base_info:
# Your blog website title
Expand All @@ -18,7 +18,7 @@ base_info:

# ---------------------------------------------------------------------------------------
# Theme style settings
# Docs: https://keep-docs.xpoet.cn/tutorial/configuration-guide/style.html
# Docs: https://keep-docs.xpoet.cn/basis/configuration-guide/style.html
# ---------------------------------------------------------------------------------------
style:
# Theme primary color
Expand Down Expand Up @@ -58,7 +58,7 @@ style:

# ---------------------------------------------------------------------------------------
# Navigation menu
# Docs: https://keep-docs.xpoet.cn/tutorial/configuration-guide/menu.html
# Docs: https://keep-docs.xpoet.cn/basis/configuration-guide/menu.html
# ---------------------------------------------------------------------------------------
# If you want to enable Categories and Tags, you need to create categories and tags pages
# e.g. `hexo new page categories` or `hexo new page tags`
Expand All @@ -74,7 +74,7 @@ menu:

# ---------------------------------------------------------------------------------------
# Social contact link
# Docs: https://keep-docs.xpoet.cn/tutorial/configuration-guide/social_contact.html
# Docs: https://keep-docs.xpoet.cn/basis/configuration-guide/social_contact.html
# ---------------------------------------------------------------------------------------
social_contact:
enable: false # Option values: true | false
Expand All @@ -94,7 +94,7 @@ social_contact:

# ---------------------------------------------------------------------------------------
# Home page article block display settings
# Docs: https://keep-docs.xpoet.cn/tutorial/configuration-guide/home_article.html
# Docs: https://keep-docs.xpoet.cn/basis/configuration-guide/home_article.html
# ---------------------------------------------------------------------------------------
home_article:
# Show category in home page article block
Expand All @@ -108,7 +108,7 @@ home_article:

# ---------------------------------------------------------------------------------------
# Post page Settings
# Docs: https://keep-docs.xpoet.cn/tutorial/configuration-guide/post.html
# Docs: https://keep-docs.xpoet.cn/basis/configuration-guide/post.html
# ---------------------------------------------------------------------------------------
post:
# Author label in the post
Expand Down Expand Up @@ -146,7 +146,7 @@ post:

# ---------------------------------------------------------------------------------------
# Code block
# Docs: https://keep-docs.xpoet.cn/tutorial/configuration-guide/code_block.html
# Docs: https://keep-docs.xpoet.cn/basis/configuration-guide/code_block.html
# ---------------------------------------------------------------------------------------
code_block:
# Toolbar include: "code copy", "code block collapse" and "code language"
Expand All @@ -157,7 +157,7 @@ code_block:

# ---------------------------------------------------------------------------------------
# Table of Contents in the Sidebar
# Docs: https://keep-docs.xpoet.cn/tutorial/configuration-guide/toc.html
# Docs: https://keep-docs.xpoet.cn/basis/configuration-guide/toc.html
# ---------------------------------------------------------------------------------------
toc:
enable: false # Option values: true | false
Expand All @@ -176,7 +176,7 @@ toc:

# ---------------------------------------------------------------------------------------
# Website count
# Docs: https://keep-docs.xpoet.cn/tutorial/configuration-guide/website_count.html
# Docs: https://keep-docs.xpoet.cn/basis/configuration-guide/website_count.html
# ---------------------------------------------------------------------------------------
website_count:
# busuanzi
Expand All @@ -189,7 +189,7 @@ website_count:

# ---------------------------------------------------------------------------------------
# Local Search
# Docs: https://keep-docs.xpoet.cn/tutorial/configuration-guide/local_search.html
# Docs: https://keep-docs.xpoet.cn/basis/configuration-guide/local_search.html
# Dependencies: hexo-generator-searchdb (`npm install hexo-generator-searchdb`)
# See: https://github.com/theme-next/hexo-generator-searchdb
# ---------------------------------------------------------------------------------------
Expand All @@ -199,7 +199,7 @@ local_search:

# ---------------------------------------------------------------------------------------
# Comment plugin
# Docs: https://keep-docs.xpoet.cn/tutorial/configuration-guide/comment.html
# Docs: https://keep-docs.xpoet.cn/basis/configuration-guide/comment.html
# ---------------------------------------------------------------------------------------
comment:
enable: false # Option values: true | false
Expand Down Expand Up @@ -254,7 +254,7 @@ comment:

# ---------------------------------------------------------------------------------------
# RSS
# Docs: https://keep-docs.xpoet.cn/tutorial/configuration-guide/rss.html
# Docs: https://keep-docs.xpoet.cn/basis/configuration-guide/rss.html
# Dependencies: hexo-generator-feed (`npm install hexo-generator-feed`)
# See: https://github.com/hexojs/hexo-generator-feed
# ---------------------------------------------------------------------------------------
Expand All @@ -263,29 +263,29 @@ rss:

# ---------------------------------------------------------------------------------------
# Lazyload image
# Docs: https://keep-docs.xpoet.cn/tutorial/configuration-guide/lazyload.html
# Docs: https://keep-docs.xpoet.cn/basis/configuration-guide/lazyload.html
# ---------------------------------------------------------------------------------------
lazyload:
enable: false # Option values: true | false

# ---------------------------------------------------------------------------------------
# CDN
# Docs: https://keep-docs.xpoet.cn/tutorial/configuration-guide/cdn.html
# Docs: https://keep-docs.xpoet.cn/basis/configuration-guide/cdn.html
# ---------------------------------------------------------------------------------------
cdn:
enable: false # Option values: true | false
provider: jsdelivr # Option values: jsdelivr | unpkg

# ---------------------------------------------------------------------------------------
# PJAX
# Docs: https://keep-docs.xpoet.cn/tutorial/configuration-guide/pjax.html
# Docs: https://keep-docs.xpoet.cn/basis/configuration-guide/pjax.html
# ---------------------------------------------------------------------------------------
pjax:
enable: false # Option values: true | false

# ---------------------------------------------------------------------------------------
# Footer settings
# Docs: https://keep-docs.xpoet.cn/tutorial/configuration-guide/footer.html
# Docs: https://keep-docs.xpoet.cn/basis/configuration-guide/footer.html
# ---------------------------------------------------------------------------------------
footer:
since: 2020 # The starting year of your website, Can be null
Expand Down Expand Up @@ -315,7 +315,7 @@ footer:

# ---------------------------------------------------------------------------------------
# Inject custom CSS and JavaScript files
# Docs: https://keep-docs.xpoet.cn/tutorial/configuration-guide/inject.html
# Docs: https://keep-docs.xpoet.cn/basis/configuration-guide/inject.html
# ---------------------------------------------------------------------------------------
inject:
enable: false # Option values: true | false
Expand Down
45 changes: 20 additions & 25 deletions docs/README_zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,41 +4,40 @@
<a title="English" href="../README.md">English</a> |
<a title="Chinese" href="README_zh-TW.md">繁體中文</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>
<a href="https://xpoet.cn"><img align="center" alt="Keep" src="https://xpoet.cn/images/keep-slogan.svg"></a>

# hexo-theme-keep

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

[![Author](https://img.shields.io/badge/author-XPoet-violet.svg?style=flat-square)](https://github.com/XPoet)
[![Github License](https://img.shields.io/github/license/XPoet/hexo-theme-keep.svg?style=flat-square&logo=github)](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&logo=github)](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=14.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)
[![Github License](https://img.shields.io/github/license/XPoet/hexo-theme-keep?style=for-the-badge&logo=github&color=3366CC)](https://github.com/XPoet/hexo-theme-keep/blob/master/LICENSE)
[![NPM version](https://img.shields.io/npm/v/hexo-theme-keep?style=for-the-badge&logo=npm&color=FF9999)](https://www.npmjs.com/package/hexo-theme-keep)
[![NPM Downloads](https://img.shields.io/npm/dw/hexo-theme-keep?style=for-the-badge&logo=npm&color=9966CC)](https://www.npmjs.com/package/hexo-theme-keep)
[![Node.js Version](https://img.shields.io/badge/node-%3E=14.0.0-009999?style=for-the-badge&logo=Node.js)](https://nodejs.org/)
[![Required Hexo version](https://img.shields.io/badge/hexo-%3E=5.0.0-99ccff?style=for-the-badge&logo=hexo)](https://hexo.io)

## :star2: 在线预览

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

> 如果你想把自己的博客链接放在在线预览列表里,可以给作者提 PR
> 如果你想把自己的博客链接放置在线预览列表里,可以给作者提 PR。
## :rocket: 安装

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

```sh
# 推荐
$ cd hexo-site

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

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

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

Expand All @@ -53,7 +52,7 @@ theme: keep
请查看 **Keep** 官方文档:
- **[Keep 官方文档](https://keep-docs.xpoet.cn/)**
- **[Keep 主题配置指南](https://keep-docs.xpoet.cn/tutorial/configuration-guide/base_info.html)**
- **[Keep 主题配置指南](https://keep-docs.xpoet.cn/basis/configuration-guide/base_info.html)**
- **[Keep 主题进阶使用](https://keep-docs.xpoet.cn/advanced/set-language.html)**
不推荐直接修改 **Keep** 主题的文件。因为这可能导致错误(例如 git merge 冲突),并且在升级主题时修改的文件可能丢失。
Expand All @@ -62,11 +61,12 @@ theme: keep
**Keep** 不定期发布新版本,你可以通过如下命令更新 **Keep**。
通过 npm 安装最新版本:
通过 NPM 安装最新版本:
```sh
# 推荐
$ cd hexo-site

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

Expand All @@ -79,7 +79,7 @@ $ git pull

## :art: 贡献

我们欢迎你加入 **Keep** 的开发,贡献出你的一份力量。请看 [Keep 代码贡献指南](https://keep.xpoet.cn/2020/11/Keep-代码贡献指南/)
我们欢迎你加入 **Keep** 的开发,贡献出你的一份力量。请看 [Keep 代码贡献指南](https://keep-docs.xpoet.cn/user-notice/contribution-guide.html)

## :clapper: 贡献者

Expand All @@ -93,13 +93,8 @@ $ git pull

**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 和 UNPKG 提供了 CDN 服务。
- [GitHub](https://github.com) 容许我们托管 Git 仓库及运行测试。
- [jsDelivr](https://www.jsdelivr.com)[UNPKG](https://www.unpkg.com) 提供了 CDN 服务。

## :memo: 许可

Expand Down
Loading

0 comments on commit c1b9caf

Please sign in to comment.