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

107 lines
3.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<div align="right">
語言:
繁中
<a title="English" href="../README.md">English</a>
<a title="Chinese" href="README_zh-CN.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>
# 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=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)
## :star2: 線上預覽
- **[XPoet's Blog](https://xpoet.cn/)**
- **[keep 預覽網頁](https://keep.xpoet.cn/)**
> 如果你想把自己的博客鏈接放在線上預覽列表裏,可以給作者提 PR 。
## :rocket: 安装
如果你在使用 Hexo 5.0 或更高版本,最簡單的安裝方式是透過 npm
```sh
# 推薦
$ cd hexo-site
$ npm install hexo-theme-keep
```
你也可以直接 clone 整個原始碼庫:
```sh
$ cd hexo-site
$ git clone https://github.com/XPoet/hexo-theme-keep --depth=1 themes/keep
```
安裝完成後,在 Hexo 配置文件中將 `theme` 設定為 `keep`
```yml
theme: keep
```
## :wrench: 使用
請查看 «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/advanced/set-language.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
```
## :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://contrib.rocks/image?repo=XPoet/hexo-theme-keep" />
</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 和 UNPKG 提供了 CDN 服務。
## :memo: 許可
[GPL-3.0](https://github.com/XPoet/hexo-theme-keep/blob/master/LICENSE) Copyright © 2020-present XPoet