Skip to content

Commit

Permalink
✨feat: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
王卓Sco committed Feb 16, 2024
1 parent aa86bfe commit 569c8a8
Show file tree
Hide file tree
Showing 3 changed files with 172 additions and 0 deletions.
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@

```bash
$ #do some change on the content
$ git commit -am "Fix issue #1: change something"
$ git push
```

*`GitHub` 上提交 `Pull Request`
* 定期使用项目仓库内容更新自己仓库内容。

```bash
$ git remote add upstream https://github.com/wleelw/Hexo-theme-solitude
$ git fetch upstream
$ git checkout dev
$ git rebase upstream/dev
$ git push -f origin dev
```

* 不得添加任何第三方的创作,请自行创作插件并`PR``solitude-pugins` 仓库

### 插件创作
* 插件创作

```
$ git clone git@github.com:{your-github-username}/solitude-plugins.git
$ git config user.name "yourname"
$ git config user.email "your email"
```

* 根据 `README` 进行添加。
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@

> 欢迎你对本主题做出贡献![贡献指南](/CONTRIBUTING.md)
## 📷 截图

### 首页
![首页](https://github.com/wleelw/hexo-theme-solitude/assets/74389842/d008aba4-942d-4fdb-a611-d934c0bad9fe)

### 即刻短文
![即刻短文](https://github.com/wleelw/hexo-theme-solitude/assets/74389842/ef6b2657-25e1-4aab-a9b3-eb631840c8da)

### 友情链接
![友情链接](https://github.com/wleelw/hexo-theme-solitude/assets/74389842/d82cf750-8679-4a54-b3e2-96ec01e9665f)

### 音乐馆
![音乐馆](https://github.com/wleelw/hexo-theme-solitude/assets/74389842/ec8c9276-5b43-4950-99a2-c94cb0e5c39e)

### 装备
![装备](https://github.com/wleelw/hexo-theme-solitude/assets/74389842/26596846-f39e-4981-8083-ad1c3e8de290)

### 工具箱
![工具箱](https://github.com/wleelw/hexo-theme-solitude/assets/74389842/d52e6dde-a8a9-4d3c-aa21-fddcfe47de23)

### 关于
![关于](https://github.com/wleelw/hexo-theme-solitude/assets/74389842/46d9db0d-a2d8-4c69-a393-f3388389fbcb)
117 changes: 117 additions & 0 deletions README_EN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
<div align="right">
<a title="English" href="/README.md">中文</a>
</div>


## Hexo-Theme-Solitude

![master version](https://img.shields.io/github/package-json/v/wleelw/hexo-theme-solitude/master?color=%231ab1ad&label=master)
![master version](https://img.shields.io/github/package-json/v/wleelw/hexo-theme-solitude/dev?label=dev)
![https://img.shields.io/npm/v/hexo-theme-solitude?color=%09%23bf00ff](https://img.shields.io/npm/v/hexo-theme-solitude?color=%09%23bf00ff)
![hexo version](https://img.shields.io/badge/hexo-6.3.0+-0e83c)
![license](https://img.shields.io/github/license/wleelw/hexo-theme-solitude?color=FF5531)

![首页](https://github.com/wleelw/hexo-theme-solitude/assets/74389842/d008aba4-942d-4fdb-a611-d934c0bad9fe)

Theme Preview: [王卓Sco](https://blog.wzsco.cn/)[Demo](https://solitude.wzsco.cn/)

Theme Document: [中文](https://docs.wzsco.cn/)[ English ](https://docs.wzsco.cn/en/)

Theme discussion group:`The usage document above contains a QR code`

## 💻 Installation

### Installation via Git

> This repository is also uploaded to [Gitee](https://gitee.com/nsjjd_w/hexo-theme-solitude). If you have trouble accessing Github, you can download it from Gitee.
Install the stable version in the root of your blog directory 【Recommended】

```powershell
git clone -b main https://github.com/wleelw/hexo-theme-solitude.git themes/solitude
```

If you want to install the latest development version, you can install the dev branch in the root of your blog directory

```powershell
git clone -b dev https://github.com/wleelw/hexo-theme-solitude.git themes/solitude
```

### Installation via npm

> This method only supports Hexo versions above 5.0.0. Installing through npm will not generate a theme folder in themes, but in node_modules instead.
Execute the following command in the root of your blog directory:

```powershell
npm install hexo-theme-solitude
```

## ⚙ Applying the Theme

Modify the hexo configuration file `_config.yml` and change the theme to `solitude`

```
theme: solitude
```

## 🎉 Features

- [x] Lazy loading of page components (pjax scheme)
- [x] Lazy loading of images
- [x] Multiple code highlighting schemes
- [x] Multi-language configuration
- [x] Support for multiple comment plugins
- [x] Built-in web page access statistics
- [x] Support for dark mode
- [x] Support for footnote syntax
- [x] Support for custom CDN static resources
- [x] Support multi-function right-click menu
- [x] Support for customizing the main color to change with the color of the cover image
- [x] Support for immersive status bars
- [x] Support for chat system
- [x] Support for Baidu Analytics
- [x] Support viewing large images
- [x] Support for waterfall instant talk
- [x] Support for custom icons (iconfont, CoDeSign, fontawesome)
- [x] Support SWPP and PWA features for caching
- [x] Excellent privacy protocol support
- [x] Article abstract AI support
- [x] Support for global center consoles
- [x] Support local search/algolia search 🔍
- [x] Support for Katex math formulas
- [x] PWA support

## ✨ Contributors

<a href="https://github.com/wleelw/hexo-theme-solitude/graphs/contributors">
<img src="https://contrib.rocks/image?repo=wleelw/hexo-theme-solitude" />
</a>

**This theme is a derivative theme of [Heo](https://blog.zhheo.com/), designed and authorized by the author [张洪Heo](https://github.com/zhheo)!**

> Welcome to contribute to this theme! [Contribution Guide](/CONTRIBUTING.md)
## 📷 Preview

### Home
![Home](https://github.com/wleelw/hexo-theme-solitude/assets/74389842/d008aba4-942d-4fdb-a611-d934c0bad9fe)

### Essay
![Essay](https://github.com/wleelw/hexo-theme-solitude/assets/74389842/ef6b2657-25e1-4aab-a9b3-eb631840c8da)

### Links
![Links](https://github.com/wleelw/hexo-theme-solitude/assets/74389842/d82cf750-8679-4a54-b3e2-96ec01e9665f)

### Music
![Music](https://github.com/wleelw/hexo-theme-solitude/assets/74389842/ec8c9276-5b43-4950-99a2-c94cb0e5c39e)

### Equip
![Equip](https://github.com/wleelw/hexo-theme-solitude/assets/74389842/26596846-f39e-4981-8083-ad1c3e8de290)

### Tools of link
![Tools of link](https://github.com/wleelw/hexo-theme-solitude/assets/74389842/d52e6dde-a8a9-4d3c-aa21-fddcfe47de23)

### About
![About](https://github.com/wleelw/hexo-theme-solitude/assets/74389842/46d9db0d-a2d8-4c69-a393-f3388389fbcb)

0 comments on commit 569c8a8

Please sign in to comment.