chore(docs): update readme file

This commit is contained in:
ppoffice 2020-08-29 18:39:22 -04:00
parent ad8a3ecc87
commit fbeb3c43b8
No known key found for this signature in database
GPG Key ID: B33335481CC0D498
2 changed files with 46 additions and 117 deletions

161
README.md
View File

@ -8,136 +8,65 @@
<br> <br>
</p> </p>
![Icarus](https://ppoffice.github.io/hexo-theme-icarus/gallery/preview.png?1 "Icarus Preview") ![](https://ppoffice.github.io/hexo-theme-icarus/gallery/preview.png?1 "Icarus Preview")
### :cd: Installation ## :cd: Installation
**Method 1: Direct download**
Download & extract or `git clone` Icarus from GitHub to your blog's theme folder:
```shell
$ git clone https://github.com/ppoffice/hexo-theme-icarus.git -b <version> themes/icarus
```
**Method 2: Install via NPM (new in Hexo 5.0 and Icarus 4.0)**
```shell ```shell
$ npm install hexo-theme-icarus $ npm install hexo-theme-icarus
```
Then, activate Icarus in Hexo's configuration file:
```shell
$ hexo config theme icarus $ hexo config theme icarus
``` ```
### :gift: Features Please refer to [Getting Started with Icarus](https://ppoffice.github.io/hexo-theme-icarus/uncategorized/getting-started-with-icarus/)
for more details.
**Cyberpunk Theme Variant** ## :gift: Features
### Cyberpunk Theme Variant
Tap into the future cyber world with the newly added Cyberpunk theme variant. Tap into the future cyber world with the newly added Cyberpunk theme variant.
Inspired by [Cyberpunk 2077](https://www.cyberpunk.net). Inspired by [Cyberpunk 2077](https://www.cyberpunk.net).
![Icarus Cyberpunk](https://ppoffice.github.io/hexo-theme-icarus/gallery/screenshots/cyberpunk.png "Icarus Cyberpunk") ![Icarus Cyberpunk](https://ppoffice.github.io/hexo-theme-icarus/gallery/screenshots/cyberpunk.png "Icarus Cyberpunk")
**Extensive Plugin Support** ### Extensive Plugin Support
Icarus includes plentiful search, comment, sharing and other plugins out of the box that makes your Icarus includes plentiful search, comment, sharing and other plugins out of the box that makes your
blog feature-rich and powerful. blog feature-rich and powerful.
<table> **[Comment](https://ppoffice.github.io/hexo-theme-icarus/categories/Plugins/Comment/)**
<tr>
<th><a href="https://ppoffice.github.io/hexo-theme-icarus/categories/Plugins/Comment/">Comment</a></th>
<th><a href="https://ppoffice.github.io/hexo-theme-icarus/categories/Plugins/Donation/">Donation</a></th>
<th><a href="https://ppoffice.github.io/hexo-theme-icarus/categories/Plugins/Search/">Search</a></th>
<th><a href="https://ppoffice.github.io/hexo-theme-icarus/categories/Plugins/Share/">Share</a></th>
<th><a href="https://ppoffice.github.io/hexo-theme-icarus/categories/Widgets/">Widgets</a></th>
<th><a href="https://ppoffice.github.io/hexo-theme-icarus/categories/Plugins/">Other Plugins</a></th>
</tr>
<tr>
<td>Changyan</td>
<td>Alipay</td>
<td>Insight</td>
<td>AddThis</td>
<td>Google AdSense</td>
<td>Baidu Analytics</td>
</tr>
<tr>
<td>Disqus</td>
<td>Buy Me A Coffee</td>
<td>Algolia</td>
<td>AddToAny</td>
<td>Archives</td>
<td>BuSuanZi Vistor Counter</td>
</tr>
<tr>
<td>DisqusJS</td>
<td>Patreon</td>
<td>Google CSE</td>
<td>Baidu Share</td>
<td>Categories</td>
<td>CNZZ Analytics</td>
</tr>
<tr>
<td>Facebook</td>
<td>Paypal</td>
<td>Baidu</td>
<td>Share.js</td>
<td>External Site Links</td>
<td>Light and Justified Gallery</td>
</tr>
<tr>
<td>Gitalk</td>
<td>Wechat</td>
<td></td>
<td>ShareThis</td>
<td>Recent Posts</td>
<td>Google Analytics</td>
</tr>
<tr>
<td>Gitment</td>
<td></td>
<td></td>
<td></td>
<td>Google Feedburner</td>
<td>Hotjar User Feedback</td>
</tr>
<tr>
<td>Isso</td>
<td></td>
<td></td>
<td></td>
<td>Author Profile</td>
<td>KaTex</td>
</tr>
<tr>
<td>LiveRe</td>
<td></td>
<td></td>
<td></td>
<td>Tags</td>
<td>MathJax</td>
</tr>
<tr>
<td>Utterances</td>
<td></td>
<td></td>
<td></td>
<td>Table of Contents</td>
<td>Outdated Browser Detection</td>
</tr>
<tr>
<td>Valine</td>
<td></td>
<td></td>
<td></td>
<td></td>
<td>Page Loading Animations<br></td>
</tr>
</table>
**Rich Code Highlight Theme Choices** Changyan &middot; Disqus &middot; DisqusJS &middot; Facebook &middot; Gitalk &middot; Gitment &middot;
Isso &middot; LiveRe &middot; Utterance &middot; Valine
**[Donate Button](https://ppoffice.github.io/hexo-theme-icarus/categories/Plugins/Donation/)**
Afdian.net &middot; Alipay &middot; Buy me a coffee &middot; Patreon &middot; Paypal &middot; Wecat
**[Search](https://ppoffice.github.io/hexo-theme-icarus/categories/Plugins/Search/)**
Algolia &middot; Baidu &middot; Google CSE &middot; Insight
**[Share](https://ppoffice.github.io/hexo-theme-icarus/categories/Plugins/Share/)**
AddThis &middot; AddToAny &middot; Baidu Share &middot; Share.js &middot; ShareThis
**[Widgets](https://ppoffice.github.io/hexo-theme-icarus/categories/Widgets/)**
Google Adsense &middot; Archives &middot; Categories &middot; External Site Links &middot;
Recent Posts &middot; Google Feedburner &middot; Tags &middot; Table of Contents
**[Analytics](https://blog.zhangruipeng.me/hexo-theme-icarus/Plugins/Analytics/icarus-user-guide-web-analytics-plugins/)**
Baidu Statistics &middot; BuSuanZi Web Counter &middot; CNZZ Statistics &middot; Google Analytics &middot;
Hotjar
**[Other Plugins](https://ppoffice.github.io/hexo-theme-icarus/categories/Plugins/)**
LightGallery &middot; Justified Gallery &middot; KaTeX &middot; MathJax &middot; Oudated Browser &middot;
Page Loading Animations
### Colorful Code Highlight
Icarus directly import stylesheets from the [highlight.js](https://highlightjs.org/) package and makes more than Icarus directly import stylesheets from the [highlight.js](https://highlightjs.org/) package and makes more than
90 code highlight themes available to you. 90 code highlight themes available to you.
@ -155,7 +84,7 @@ Icarus directly import stylesheets from the [highlight.js](https://highlightjs.o
</tr> </tr>
</table> </table>
**Flexible Theme Configuration** ### Flexible Theme Configuration
Icarus allows you to configure your site on a per-page or per-layout basis. Icarus allows you to configure your site on a per-page or per-layout basis.
@ -197,13 +126,13 @@ Icarus allows you to configure your site on a per-page or per-layout basis.
</table> </table>
</div> </div>
**Responsive Layout** ### Responsive Layout
Give your audiences best viewing experience with Icarus's mobile-friendly responsive layout. Give your audiences best viewing experience with Icarus's mobile-friendly responsive layout.
![Responsive Layout](https://ppoffice.github.io/hexo-theme-icarus/gallery/responsive.png) ![Responsive Layout](https://ppoffice.github.io/hexo-theme-icarus/gallery/responsive.png)
### :hammer: Development ## :hammer: Development
This project is built with This project is built with
@ -215,7 +144,7 @@ This project is built with
Please refer to the [documentation](https://ppoffice.github.io/hexo-theme-icarus/categories/) and Please refer to the [documentation](https://ppoffice.github.io/hexo-theme-icarus/categories/) and
[contributing guide](https://github.com/ppoffice/hexo-theme-icarus/blob/master/CONTRIBUTING.md) for implementation details. [contributing guide](https://github.com/ppoffice/hexo-theme-icarus/blob/master/CONTRIBUTING.md) for implementation details.
### :tada: Contribute ## :tada: Contribute
If you feel like to help us build a better Icarus, you can If you feel like to help us build a better Icarus, you can
@ -224,6 +153,6 @@ If you feel like to help us build a better Icarus, you can
:triangular_flag_on_post: [Report a bug](https://github.com/ppoffice/hexo-theme-icarus/issues/new) | :triangular_flag_on_post: [Report a bug](https://github.com/ppoffice/hexo-theme-icarus/issues/new) |
:electric_plug: [Suggest a new feature](https://github.com/ppoffice/hexo-theme-icarus/pulls) :electric_plug: [Suggest a new feature](https://github.com/ppoffice/hexo-theme-icarus/pulls)
### :memo: License ## :memo: License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/ppoffice/hexo-theme-icarus/blob/master/LICENSE) file for details. This project is licensed under the MIT License - see the [LICENSE](https://github.com/ppoffice/hexo-theme-icarus/blob/master/LICENSE) file for details.

View File

@ -30,7 +30,7 @@
"bulma-stylus": "0.8.0", "bulma-stylus": "0.8.0",
"deepmerge": "^4.2.2", "deepmerge": "^4.2.2",
"hexo": "^5.0.2", "hexo": "^5.0.2",
"hexo-component-inferno": "^0.8.0", "hexo-component-inferno": "^0.8.2",
"hexo-log": "^2.0.0", "hexo-log": "^2.0.0",
"hexo-pagination": "^1.0.0", "hexo-pagination": "^1.0.0",
"hexo-renderer-inferno": "^0.1.3", "hexo-renderer-inferno": "^0.1.3",