From fbeb3c43b86bf0abe03b6ea6f07bd38377a8ce7a Mon Sep 17 00:00:00 2001 From: ppoffice Date: Sat, 29 Aug 2020 18:39:22 -0400 Subject: [PATCH] chore(docs): update readme file --- README.md | 161 ++++++++++++++------------------------------------- package.json | 2 +- 2 files changed, 46 insertions(+), 117 deletions(-) diff --git a/README.md b/README.md index 89dddfd..aaaf710 100644 --- a/README.md +++ b/README.md @@ -8,136 +8,65 @@

-![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 - -**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 themes/icarus -``` - -**Method 2: Install via NPM (new in Hexo 5.0 and Icarus 4.0)** +## :cd: Installation ```shell $ npm install hexo-theme-icarus -``` - -Then, activate Icarus in Hexo's configuration file: - -```shell $ 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. Inspired by [Cyberpunk 2077](https://www.cyberpunk.net). ![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 blog feature-rich and powerful. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
CommentDonationSearchShareWidgetsOther Plugins
ChangyanAlipayInsightAddThisGoogle AdSenseBaidu Analytics
DisqusBuy Me A CoffeeAlgoliaAddToAnyArchivesBuSuanZi Vistor Counter
DisqusJSPatreonGoogle CSEBaidu ShareCategoriesCNZZ Analytics
FacebookPaypalBaiduShare.jsExternal Site LinksLight and Justified Gallery
GitalkWechatShareThisRecent PostsGoogle Analytics
GitmentGoogle FeedburnerHotjar User Feedback
IssoAuthor ProfileKaTex
LiveReTagsMathJax
UtterancesTable of ContentsOutdated Browser Detection
ValinePage Loading Animations
+**[Comment](https://ppoffice.github.io/hexo-theme-icarus/categories/Plugins/Comment/)** -**Rich Code Highlight Theme Choices** +Changyan · Disqus · DisqusJS · Facebook · Gitalk · Gitment · +Isso · LiveRe · Utterance · Valine + +**[Donate Button](https://ppoffice.github.io/hexo-theme-icarus/categories/Plugins/Donation/)** + +Afdian.net · Alipay · Buy me a coffee · Patreon · Paypal · Wecat + +**[Search](https://ppoffice.github.io/hexo-theme-icarus/categories/Plugins/Search/)** + +Algolia · Baidu · Google CSE · Insight + +**[Share](https://ppoffice.github.io/hexo-theme-icarus/categories/Plugins/Share/)** + +AddThis · AddToAny · Baidu Share · Share.js · ShareThis + +**[Widgets](https://ppoffice.github.io/hexo-theme-icarus/categories/Widgets/)** + +Google Adsense · Archives · Categories · External Site Links · +Recent Posts · Google Feedburner · Tags · Table of Contents + +**[Analytics](https://blog.zhangruipeng.me/hexo-theme-icarus/Plugins/Analytics/icarus-user-guide-web-analytics-plugins/)** + +Baidu Statistics · BuSuanZi Web Counter · CNZZ Statistics · Google Analytics · +Hotjar + +**[Other Plugins](https://ppoffice.github.io/hexo-theme-icarus/categories/Plugins/)** + +LightGallery · Justified Gallery · KaTeX · MathJax · Oudated Browser · +Page Loading Animations + +### Colorful Code Highlight Icarus directly import stylesheets from the [highlight.js](https://highlightjs.org/) package and makes more than 90 code highlight themes available to you. @@ -155,7 +84,7 @@ Icarus directly import stylesheets from the [highlight.js](https://highlightjs.o -**Flexible Theme Configuration** +### Flexible Theme Configuration 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. -**Responsive Layout** +### 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) -### :hammer: Development +## :hammer: Development 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 [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 @@ -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) | :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. diff --git a/package.json b/package.json index a527acb..7b2e128 100644 --- a/package.json +++ b/package.json @@ -30,7 +30,7 @@ "bulma-stylus": "0.8.0", "deepmerge": "^4.2.2", "hexo": "^5.0.2", - "hexo-component-inferno": "^0.8.0", + "hexo-component-inferno": "^0.8.2", "hexo-log": "^2.0.0", "hexo-pagination": "^1.0.0", "hexo-renderer-inferno": "^0.1.3",