hexo-theme-amane/README.md

159 lines
5.7 KiB
Markdown
Raw Normal View History

<p align="center" class="mb-2">
2019-12-25 01:34:27 +00:00
<img class="not-gallery-item" height="48" src="https://ppoffice.github.io/hexo-theme-icarus/img/logo.svg">
<br> A simple, delicate, and modern theme for the static site generator Hexo.
<br>
<a href="https://ppoffice.github.io/hexo-theme-icarus/">Preview</a> |
<a href="https://ppoffice.github.io/hexo-theme-icarus/categories/">Documentation</a> |
<a href="https://github.com/ppoffice/hexo-theme-icarus/discussions">Discuss on GitHub</a>
<br>
</p>
2020-08-29 22:39:22 +00:00
![](https://ppoffice.github.io/hexo-theme-icarus/gallery/preview.png?1 "Icarus Preview")
2020-08-29 22:39:22 +00:00
## :cd: Installation
2015-03-20 10:01:52 +00:00
```shell
$ npm install hexo-theme-icarus
$ hexo config theme icarus
```
2015-12-07 14:59:56 +00:00
2020-08-29 22:39:22 +00:00
Please refer to [Getting Started with Icarus](https://ppoffice.github.io/hexo-theme-icarus/uncategorized/getting-started-with-icarus/)
for more details.
2015-03-20 10:01:52 +00:00
2020-08-29 22:39:22 +00:00
## :gift: Features
### Cyberpunk Theme Variant
2016-07-07 14:05:13 +00:00
Tap into the future cyber world with the newly added Cyberpunk theme variant.
Inspired by [Cyberpunk 2077](https://www.cyberpunk.net).
2016-07-07 14:05:13 +00:00
![Icarus Cyberpunk](https://ppoffice.github.io/hexo-theme-icarus/gallery/screenshots/cyberpunk.png "Icarus Cyberpunk")
2018-12-23 20:12:01 +00:00
2020-08-29 22:39:22 +00:00
### Extensive Plugin Support
2018-12-23 20:12:01 +00:00
Icarus includes plentiful search, comment, sharing and other plugins out of the box that makes your
blog feature-rich and powerful.
2016-02-08 12:11:26 +00:00
2020-08-29 22:39:22 +00:00
**[Comment](https://ppoffice.github.io/hexo-theme-icarus/categories/Plugins/Comment/)**
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
2020-10-04 06:21:59 +00:00
**[Analytics](https://ppoffice.github.io/hexo-theme-icarus/Plugins/Analytics/icarus-user-guide-web-analytics-plugins/)**
2020-08-29 22:39:22 +00:00
2020-10-04 06:21:59 +00:00
Baidu Statistics &middot; Bing Webmaster &middot; BuSuanZi Web Counter &middot; CNZZ Statistics &middot;
Google Analytics &middot; Hotjar &middot; StatCounter &middot; Twitter Conversion Tracking
2020-08-29 22:39:22 +00:00
**[Other Plugins](https://ppoffice.github.io/hexo-theme-icarus/categories/Plugins/)**
2020-10-04 06:21:59 +00:00
Cookie Consent &middot; LightGallery &middot; Justified Gallery &middot; KaTeX &middot; MathJax &middot;
Oudated Browser &middot; Page Loading Animations
2015-05-28 01:36:20 +00:00
2020-08-29 22:39:22 +00:00
### Colorful Code Highlight
2015-05-28 01:36:20 +00:00
Icarus directly import stylesheets from the [highlight.js](https://highlightjs.org/) package and makes more than
90 code highlight themes available to you.
2015-03-20 10:01:52 +00:00
2018-10-26 04:58:16 +00:00
<table>
<tr>
2020-03-12 18:18:00 +00:00
<th>Atom One Light</th>
<th>Monokai</th>
<th>Kimbie Dark</th>
</tr>
<tr>
<td><img width="266" src="https://ppoffice.github.io/hexo-theme-icarus/gallery/code-highlight/atom-one-light.png?2"></td>
<td><img width="266" src="https://ppoffice.github.io/hexo-theme-icarus/gallery/code-highlight/monokai.png?2"></td>
<td><img width="266" src="https://ppoffice.github.io/hexo-theme-icarus/gallery/code-highlight/kimbie-dark.png?2"></td>
2018-10-26 04:58:16 +00:00
</tr>
</table>
2015-03-20 10:01:52 +00:00
2020-08-29 22:39:22 +00:00
### Flexible Theme Configuration
2015-03-20 10:01:52 +00:00
Icarus allows you to configure your site on a per-page or per-layout basis.
2015-05-28 01:36:20 +00:00
<div>
<table>
<tr>
<th>_config.yml</th>
<th>post.md</th>
<th>_config.page.yml</th>
</tr>
<tr>
<td>
<pre>widgets:
- type: profile
position: left
- type: recent_posts
position: right</pre>
</td>
<td>
<pre>widgets:
2020-03-12 18:18:00 +00:00
- type: profile
position: left
- type: recent_posts
position: left</pre>
</td>
<td>
<pre>widgets: null
</pre>
</td>
</tr>
<tr>
2020-03-12 18:18:00 +00:00
<td><img width="266" src="https://ppoffice.github.io/hexo-theme-icarus/gallery/screenshots/default-config.png"></td>
<td><img width="266" src="https://ppoffice.github.io/hexo-theme-icarus/gallery/screenshots/post-config.png"></td>
<td><img width="266" src="https://ppoffice.github.io/hexo-theme-icarus/gallery/screenshots/layout-config.png"></td>
</tr>
</table>
</div>
2015-05-28 01:36:20 +00:00
2020-08-29 22:39:22 +00:00
### Responsive Layout
2015-03-20 10:01:52 +00:00
Give your audiences best viewing experience with Icarus's mobile-friendly responsive layout.
2015-03-20 10:01:52 +00:00
![Responsive Layout](https://ppoffice.github.io/hexo-theme-icarus/gallery/responsive.png)
2015-03-20 10:01:52 +00:00
2020-08-29 22:39:22 +00:00
## :hammer: Development
This project is built with
- [Hexo](https://hexo.io/)
- [Inferno.js](https://infernojs.org/)
- [Stylus](https://stylus-lang.com/)
- [Bulma](https://bulma.io/)
2015-03-20 10:01:52 +00:00
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.
2015-03-20 10:01:52 +00:00
2020-08-29 22:39:22 +00:00
## :tada: Contribute
2018-10-28 05:29:47 +00:00
If you feel like to help us build a better Icarus, you can
:black_nib: [Submit a tutorial](https://github.com/ppoffice/hexo-theme-icarus/new/site/source/_posts) |
:earth_asia: [Add a translation](https://github.com/ppoffice/hexo-theme-icarus/tree/master/languages) |
2021-08-01 04:38:27 +00:00
:triangular_flag_on_post: [Report a bug](https://github.com/ppoffice/hexo-theme-icarus/issues) |
:electric_plug: [Suggest a new feature](https://github.com/ppoffice/hexo-theme-icarus/pulls)
2020-08-29 22:39:22 +00:00
## :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.