chore(doc): update documentation

pull/865/head
ppoffice 2021-06-26 16:32:16 -04:00
parent 439852c099
commit a436094780
No known key found for this signature in database
GPG Key ID: D872802C1F2A16AA
20 changed files with 27 additions and 79 deletions

View File

@ -1,23 +0,0 @@
title: LiveRe Comment Plugin
date: 2015-01-01
tags:
- Demo
comment:
type: livere
uid: MTAyMC8zNTExMS8xMTY0Ng==
---
<article class="message message-immersive is-warning">
<div class="message-body">
<i class="fas fa-exclamation-triangle mr-2"></i>This page is for demonstration only.
Please report your issues with this plugin to
<a href="https://github.com/ppoffice/hexo-component-inferno">ppoffice/hexo-component-inferno</a>.
</div>
</article>
<article class="message message-immersive is-primary">
<div class="message-body">
<i class="fas fa-info-circle mr-2"></i>
Please turn off your ad blockers if you do not see the comment section.
</div>
</article>

View File

@ -4,8 +4,8 @@ tags:
- Demo
comment:
type: valine
app_id: QuQK82UpN8gNkXIaKIszbPUY-gzGzoHsz
app_key: B0D5cYRcXrwNGnBoQdRoDTqw
app_id: sLMlQ21EdIaShsDQVH34Rqo4-MdYXbMMI
app_key: 0FTrsBsfsjE2SyMOzXFWEfkl
placeholder: ""
avatar:
avatar_force: false
@ -14,6 +14,7 @@ comment:
visitor: false
highlight: true
record_ip: false
server_urls: https://slmlq21e.api.lncldglobal.com
---
<article class="message message-immersive is-warning">

View File

@ -1,21 +0,0 @@
title: Baidu Share Buttons
date: 2014-01-01
tags:
- Demo
share:
type: bdshare
---
<article class="message message-immersive is-warning">
<div class="message-body">
<i class="fas fa-exclamation-triangle mr-2"></i>This page is for demonstration only.
Please report your issues with this plugin to
<a href="https://github.com/ppoffice/hexo-component-inferno">ppoffice/hexo-component-inferno</a>.
</div>
</article>
<article class="message message-immersive is-primary">
<div class="message-body">
<i class="fas fa-info-circle mr-2"></i>Please turn off your ad blockers if you do not see the buttons.
</div>
</article>

View File

@ -9,7 +9,7 @@ language: en
toc: true
---
This article covers comment plugins supported by Icarus 3.
This article covers comment plugins supported by Icarus 4.
<article class="message message-immersive is-primary">
<div class="message-body">
@ -318,9 +318,7 @@ However, unlike the other services, Isso requires a web host for running the Iss
</div>
</article>
<div>
<strong>Installation Guide</strong><a class="tag is-success ml-2" href="{% post_path demo/comment/LiveRe %}">Preview</a>
</div>
**Installation Guide**
1. First, log into [LiveRe](https://livere.com/).
Click "Install" on the navigation bar to go to the installation page.

View File

@ -29,7 +29,7 @@ donates:
qrcode: /gallery/donate/wechat.jpg
---
This article covers donation button configurations supported by Icarus 3.
This article covers donation button configurations supported by Icarus 4.
If you need to display multiple donation buttons at once, add individual button configuration
to the `donates` array like the following:

View File

@ -32,8 +32,8 @@ I can't generate my site. / I met some errors when I generate my site.
</div>
</article>
Icarus 3 runs on Node.js 8.3.0 or a newer version.
It also requires Hexo 4.2.0 or a newer version.
Icarus 4 runs on Node.js 12.4.0 or a newer version.
It also requires Hexo 5.0.2 or a newer version.
Apart from that, make sure you have all the Node.js dependencies installed.
You can find them in the `peerDependencies` section of the
[`<icarus_directory>/package.json`](https://github.com/ppoffice/hexo-theme-icarus/blob/master/package.json)

View File

@ -24,7 +24,7 @@ plugins:
progressbar: true
---
This article covers other plugins supported by Icarus 3.
This article covers other plugins supported by Icarus 4.
<article class="message message-immersive is-primary">
<div class="message-body">

View File

@ -9,7 +9,7 @@ language: en
toc: true
---
This article covers search plugin configurations supported by Icarus 3.
This article covers search plugin configurations supported by Icarus 4.
<article class="message message-immersive is-primary">
<div class="message-body">

View File

@ -12,7 +12,7 @@ share:
install_url: //s7.addthis.com/js/300/addthis_widget.js#pubid=ra-5e8fc96750876c7d
---
This article covers share buttons supported by Icarus 3.
This article covers share buttons supported by Icarus 4.
<article class="message message-immersive is-primary">
<div class="message-body">
@ -186,9 +186,7 @@ Use other services as alternatives.
</div>
</article>
<div>
<strong>Installation Guide</strong><a class="tag is-success ml-2" href="{% post_path demo/share/BaiduShare %}">Preview</a>
</div>
**Installation Guide**
1. You can activate Baidu Share without user registration.
Just put the following code to your theme configurations:

View File

@ -15,11 +15,11 @@ toc: true
<!-- more -->
### Upgrading from 3.x to 4.0
### Upgrading from 3.x to 4.x
1. Upgrade Node.js to 10.13.0 or a newer version.
2. Install Icarus 4.0 either via source code dowload or NPM install.
2. Install Icarus 4.x either via source code dowload or NPM install.
You can find instructions in {% post_link en/Getting-Started %}.
If you plan to customize the theme by altering its source code, you are required to install
the theme from source code.

View File

@ -9,7 +9,7 @@ language: en
toc: true
---
This article covers web analytics plugins supported by Icarus 3.
This article covers web analytics plugins supported by Icarus 4.
<article class="message message-immersive is-primary">
<div class="message-body">

View File

@ -56,7 +56,7 @@ widgets:
index: false
---
This article covers widgets supported by Icarus 3.
This article covers widgets supported by Icarus 4.
To display multiple widgets at once, simply add individual widget configuration
to the `widgets` array.
They will appear in the order of their definitions.

View File

@ -13,7 +13,7 @@ providers:
iconcdn: loli
---
本文介绍Icarus 3支持的用户评论插件的安装配置。
本文介绍Icarus 4支持的用户评论插件的安装配置。
<article class="message message-immersive is-primary">
<div class="message-body">
@ -317,9 +317,7 @@ providers:
</div>
</article>
<div>
<strong>安装指南</strong><a class="tag is-success ml-2" href="{% post_path demo/comment/LiveRe %}">在线预览</a>
</div>
**安装指南**
1. 首先,登录[LiveRe](https://livere.com/)。
点击导航栏上的“安装”(Install)链接,进入安装界面。

View File

@ -33,7 +33,7 @@ providers:
iconcdn: loli
---
本文介绍Icarus 3支持的赞赏按钮的安装配置。
本文介绍Icarus 4支持的赞赏按钮的安装配置。
若需同时展示多个按钮,只需像如下这样在主题配置的`donates`数组中添加多个按钮配置:
{% codeblock _config.icarus.yml lang:yaml %}

View File

@ -28,7 +28,7 @@ providers:
iconcdn: loli
---
本文介绍Icarus 3支持的其他插件的安装配置。
本文介绍Icarus 4支持的其他插件的安装配置。
<article class="message message-immersive is-primary">
<div class="message-body">

View File

@ -13,7 +13,7 @@ providers:
iconcdn: loli
---
本文介绍Icarus 3支持的站内搜索插件的安装配置。
本文介绍Icarus 4支持的站内搜索插件的安装配置。
<article class="message message-immersive is-primary">
<div class="message-body">

View File

@ -16,7 +16,7 @@ providers:
iconcdn: loli
---
本文介绍Icarus 3支持的分享按钮的安装配置。
本文介绍Icarus 4支持的分享按钮的安装配置。
<article class="message message-immersive is-primary">
<div class="message-body">
@ -180,10 +180,7 @@ providers:
</div>
</article>
<div>
<strong>安装指南</strong>
<a class="tag is-success" style="margin-left:.8em" href="{% post_path demo/share/BaiduShare %}">在线预览</a>
</div>
**安装指南**
1. 你可以启用百度分享按钮而无需注册用户。
直接将下面的代码添加到你的主题配置中:

View File

@ -19,11 +19,11 @@ toc: true
<!-- more -->
### 从3.x升级至4.0
### 从3.x升级至4.x
1. 将Node.js升级到10.13.0或者更新的版本。
2. 下载源代码或者从NPM安装Icarus 4.0
2. 下载源代码或者从NPM安装Icarus 4.x
你可以在{% post_link zh-CN/Getting-Started %}中找到安装指导。
如果你打算通过修改源代码的方式自定义主题,你必须从源代码安装主题。

View File

@ -13,7 +13,7 @@ providers:
iconcdn: loli
---
本文介绍Icarus 3支持的网站统计与分析插件的安装配置。
本文介绍Icarus 4支持的网站统计与分析插件的安装配置。
<article class="message message-immersive is-primary">
<div class="message-body">

View File

@ -60,7 +60,7 @@ providers:
iconcdn: loli
---
本文介绍Icarus 3支持的页面挂件的安装配置。
本文介绍Icarus 4支持的页面挂件的安装配置。
若要同时展示多个挂件,只需在主题配置的`widgets`数组中添加多个挂件配置。
它们会按照定义的顺序出现。
每个挂件必须包含`type`(挂件类型)与`position`(挂件展示位置)设置项。