github
/
hexo-theme-icarus
mirror of https://github.com/ppoffice/hexo-theme-icarus
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

chore: update documentation for Icarus 5.0

pull/1299/head
ppoffice 2022-07-20 22:12:14 -07:00
parent 280a539450
commit 4e41bb5c57
No known key found for this signature in database
GPG Key ID: D872802C1F2A16AA
18 changed files with 156 additions and 134 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
_config.yml
View File

@ -89,7 +89,8 @@ deploy:
branch: gh-pages
marked:
gfm: false
gfm: true
breaks: false
githubEmojis:
className: not-gallery-item

6
package.json
View File

@ -3,7 +3,7 @@
"version": "0.0.0",
"private": true,
"hexo": {
"version": "6.0.0"
"version": "6.2.0"
},
"dependencies": {
"bulma-stylus": "0.8.0",
@ -20,9 +20,9 @@
"hexo-renderer-marked": "^4.0.0",
"hexo-renderer-stylus": "^2.0.0",
"hexo-server": "^3.0.0",
"hexo-theme-icarus": "^5.0.0-rc.1"
"hexo-theme-icarus": "^5.0.1"
},
"resolutions": {
"stylus": "^0.54.8"
}
}
}

37
scripts/tab.js
View File

@ -1,37 +0,0 @@
hexo.extend.injector.register(
"body_end",
() => {
return `
<script>
(() => {
function switchTab() {
if (!location.hash) {
return;
}
Array
.from(document.querySelectorAll('.tab-content'))
.forEach($tab => {
$tab.classList.add('is-hidden');
});
Array
.from(document.querySelectorAll('.tabs li'))
.forEach($tab => {
$tab.classList.remove('is-active');
});
const $activeTab = document.querySelector(location.hash);
if ($activeTab) {
$activeTab.classList.remove('is-hidden');
}
const $tabMenu = document.querySelector(\`a[href="\${location.hash}"]\`);
if ($tabMenu) {
$tabMenu.parentElement.classList.add('is-active');
}
}
switchTab();
window.addEventListener('hashchange', switchTab, false);
})();
</script>
`;
},
"post"
);

9
source/_posts/demo/comment/Waline.md
View File

@ -5,6 +5,7 @@ tags:
comment:
type: waline
server_url: https://icarus-waline-comment.vercel.app
path: window.location.pathname
lang: en-US
visitor: false
emoji:
@ -15,14 +16,12 @@ comment:
- mail
- link
required_meta:
login: enable
avatar: mp
login: 'enable'
word_limit: 0
page_size: 10
avatar_cdn: 'https://sdn.geekzu.org/avatar/'
avatar_force: false
upload_image: false
highlight: true
math_tag_support: false
math: false
copyright: true
locale:
placeholder: 'Comment here...'

6
source/_posts/en/CDN-Providers.md
View File

@ -38,12 +38,18 @@ Currently, Icarus offers the following built-in CDN providers:
- jsDelivr (`jsdelivr`)
- UNPKG (`unpkg`)
- loli.net (`loli`)
- BootCDN (`bootcdn`)
- 75CDN (`75cdn`)
- **CDNs for Web Fonts**
- Google Fonts (`google`)
- loli.net (`loli`)
- font.im (`fontim`)
- ustc.edu.cn (`ustc`)
- **FontAwesome Font Icon CDNs**
- FontAwesome 5 (`fontawesome`)
- loli.net (`loli`)
- BootCDN (`bootcdn`)
- 75CDN (`75cdn`)
The default CDN settings are:

33
source/_posts/en/Comment-Plugins.md
View File

@ -372,6 +372,26 @@ However, unlike the other services, Isso requires a web host for running the Iss
{% endcodeblock %}
## Twikoo
Twikoo is a self-hosted comment system based on cloud functions.
Unlike other third-party comment services, the Twikoo backend needs to be deployed to a cloud
environment before being configured and used by Icarus.
**Installation Guide**
1. Follow the [Twikoo documentation](https://twikoo.js.org/en/) to deploy the Twikoo cloud function
to a cloud service provider of your choice.
2. Fill in the `env_id` of your deployment to the corresponding setting in the theme configurations.
{% codeblock _config.icarus.yml lang:yaml %}
comment:
type: twikoo
env_id: xxxxxxxx
{% endcodeblock %}
## utterances
<div>
@ -494,24 +514,23 @@ services until this issue has been fixed.
comment:
type: waline
server_url: https://your-domain.vercel.app
lang: zh-CN # Optional
path: window.location.pathname # Optional
lang: en-US # Optional
visitor: false # Optional
emoji: # Optional
- 'https://cdn.jsdelivr.net/gh/walinejs/emojis/weibo'
- 'https://cdn.jsdelivr.net/gh/walinejs/emojis/weibo'
dark: auto # Optional
meta: ["nick", "mail", "link"] # Optional
required_meta: [] # Optional
login: enable # Optional
avatar: mp # Optional
word_limit: 0 # Optional
page_size: 10 # Optional
avatar_cdn: 'https://sdn.geekzu.org/avatar/' # Optional
avatar_force: false # Optional
upload_image: false # Optional
highlight: true # Optional
math_tag_support: false # Optional
math: false # Optional
copyright: true # Optional
locale: # Optional
placeholder: 'Comment here...'
placeholder: 'Comment here...'
{% endcodeblock %}

2
source/_posts/en/Configuring-Theme.md
View File

@ -34,7 +34,7 @@ Icarus uses it to determine whether to upgrade the default theme configuration f
You should not change it by yourself.
{% codeblock _config.icarus.yml lang:yaml %}
version: 4.0.0
version: 5.0.0
{% endcodeblock %}
### Theme Variant

62
source/_posts/en/Getting-Started.md
View File

@ -29,49 +29,35 @@ open to a sea of improvement possibilities.
Before you continue to the installation of Icarus, take some time to review the
[Hexo documentation](https://hexo.io).
To install Icarus, take one of the following approaches:
{% tabs align:left style:boxed %}
<!-- tab id:install-source 'icon:fas fa-file-code' 'title:Install from source' -->
Download the source code tarball from the GitHub and extract it to your Hexo site's theme
directory.
Alternatively, you can use Git to clone the Icarus repository to the `themes` directory:
<div class="tabs is-boxed my-3">
<ul class="mx-0 my-0">
<li class="is-active">
<a href="#install-source">
<span class="icon is-small"><i class="fas fa-file-code" aria-hidden="true"></i></span>
<span>Install from source</span>
</a>
</li>
<li>
<a href="#install-npm">
<span class="icon is-small"><i class="fas fa-cubes" aria-hidden="true"></i></span>
<span>Install via NPM</span>
</a>
</li>
</ul>
</div>
<div id="install-source" class="tab-content">
Download the source code tarball from the GitHub and extract it to your Hexo site's theme
directory.
Alternatively, you can use Git to clone the Icarus repository to the `themes` directory:
{% codeblock "Git Bash/Shell" %}
git clone https://github.com/ppoffice/hexo-theme-icarus.git themes/icarus -b <version number> --depth 1
{% endcodeblock %}
{% codeblock "Git Bash/Shell" %}
git clone https://github.com/ppoffice/hexo-theme-icarus.git themes/icarus -b <version number> --depth 1
{% endcodeblock %}
You can omit `-b <version number>` to get the latest development version of Icarus.
Leave `--depth 1` out if you want to download full Git commit history of Icarus as well.
Furthermore, you can install Icarus as a Git submodule with the following command:
You can omit `-b <version number>` to get the latest development version of Icarus.
Leave `--depth 1` out if you want to download full Git commit history of Icarus as well.
Furthermore, you can install Icarus as a Git submodule with the following command:
{% codeblock "Git Bash/Shell" %}
git submodule add https://github.com/ppoffice/hexo-theme-icarus.git themes/icarus
{% endcodeblock %}
<!-- endtab -->
{% codeblock "Git Bash/Shell" %}
git submodule add https://github.com/ppoffice/hexo-theme-icarus.git themes/icarus
{% endcodeblock %}
</div>
<!-- tab active id:install-npm 'icon:fas fa-cubes' 'title:Install via NPM' -->
To install Icarus as a node package via NPM, run the following command
from the root of your Hexo site:
<div id="install-npm" class="tab-content is-hidden">
To install Icarus as a node package via NPM, run the following command
from the root of your Hexo site:
{% codeblock "Shell" %}
npm install -S hexo-theme-icarus
{% endcodeblock %}
</div>
{% codeblock "Shell" %}
npm install -S hexo-theme-icarus hexo-renderer-inferno
{% endcodeblock %}
<!-- endtab -->
{% endtabs %}
<hr>

1
source/_posts/en/Search-Plugins.md
View File

@ -171,6 +171,7 @@ Please refer to it for a complete list of supported plugins and their configurat
{% codeblock _config.icarus.yml lang:yaml %}
search:
type: insight
include_pages: true # Optional. Set to `false` to exclude pages from search results.
{% endcodeblock %}

16
source/_posts/en/Upgrade-Guide.md
View File

@ -15,6 +15,22 @@ toc: true
<!-- more -->
### Upgrading from 4.x to 5.0
1. Upgrade Node.js to 12.4.0 or a newer version.
2. Install Icarus 5.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.
3. Run `hexo clean` to clear cache files and let Icarus upgrade your theme configuration file for
you.
4. Check out the [release notes](https://github.com/ppoffice/hexo-theme-icarus/releases) and the
[latest documentation](https://ppoffice.github.io/hexo-theme-icarus/categories/) for more
information of the new features.
### Upgrading from 3.x to 4.x
1. Upgrade Node.js to 10.13.0 or a newer version.

6
source/_posts/en/Widgets.md
View File

@ -30,6 +30,9 @@ widgets:
-
position: left
type: tags
order_by: -name
amount:
show_count: false
-
position: left
type: followit
@ -234,6 +237,9 @@ widgets:
-
position: right
type: tags
order_by: name # Optional. Order by tag name or length. Prefix with `-` to sort in descending order.
amount: 20 # Optional. The maximum number of tags to show. Leave empty to show all.
show_count: true # Optional. Whether to show post count right to tag name.
{% endcodeblock %}

6
source/_posts/zh-CN/CDN-Providers.md
View File

@ -38,12 +38,18 @@ Icarus为你提供了几种内置的CDN提供商来承载Icaurs所用到的第
- jsDelivr (`jsdelivr`)
- UNPKG (`unpkg`)
- loli.net (`loli`)
- BootCDN (`bootcdn`)
- 75CDN (`75cdn`)
- **Web字体CDN**
- Google Fonts (`google`)
- loli.net (`loli`)
- font.im (`fontim`)
- 中国科学技术大学 (`ustc`)
- **FontAwesome图标CDN**
- FontAwesome 5 (`fontawesome`)
- loli.net (`loli`)
- BootCDN (`bootcdn`)
- 75CDN (`75cdn`)
默认的CDN服务提供商配置为：

29
source/_posts/zh-CN/Comment-Plugins.md
View File

@ -371,6 +371,24 @@ providers:
{% endcodeblock %}
## Twikoo
Twikoo是一个基于云函数的自建评论系统。
不同于其他第三方评论服务，在Icarus中设置和使用Twikoo之前，你需要将它的后端部署到云环境上。
**安装指南**
1. 按照[Twikoo文档](https://twikoo.js.org/)，将Twikoo云函数部署到你指定的云服务商之上。
2. 将你部署的`env_id`填入主题设置中的对应设置项之中。
{% codeblock _config.icarus.yml lang:yaml %}
comment:
type: twikoo
env_id: xxxxxxxx
{% endcodeblock %}
## utterances
<div>
@ -489,24 +507,23 @@ IP地址 (<a href="https://github.com/xCss/Valine/issues/336" target="_blank" re
comment:
type: waline
server_url: https://your-domain.vercel.app
path: window.location.pathname # 可选填
lang: zh-CN # 可选填
visitor: false # 可选填
emoji: # 可选填
- 'https://cdn.jsdelivr.net/gh/walinejs/emojis/weibo'
- 'https://cdn.jsdelivr.net/gh/walinejs/emojis/weibo'
dark: auto # 可选填
meta: ["nick", "mail", "link"] # 可选填
required_meta: [] # 可选填
login: enable # 可选填
avatar: mp # 可选填
word_limit: 0 # 可选填
page_size: 10 # 可选填
avatar_cdn: 'https://sdn.geekzu.org/avatar/' # 可选填
avatar_force: false # 可选填
upload_image: false # 可选填
highlight: true # 可选填
math_tag_support: false # 可选填
math: false # 可选填
copyright: true # 可选填
locale: # 可选填
placeholder: 'Comment here...'
placeholder: 'Comment here...'
{% endcodeblock %}

2
source/_posts/zh-CN/Configuring-Theme.md
View File

@ -41,7 +41,7 @@ Icarus使用此版本号来决定是否升级默认主题配置文件。
请不要自己更改这个版本号。
{% codeblock _config.icarus.yml lang:yaml %}
version: 4.0.0
version: 5.0.0
{% endcodeblock %}
### 主题变体

56
source/_posts/zh-CN/Getting-Started.md
View File

@ -31,46 +31,32 @@ Icarus同时也提供了超多插件与挂件来满足你的多元的站点个
在你继续安装Icarus之前，请先花些时间阅览[Hexo文档](https://hexo.io)。
如要安装Icarus，你可以选择如下两种方式中的任意一种：
<div class="tabs is-boxed my-3">
<ul class="mx-0 my-0">
<li class="is-active">
<a href="#install-source">
<span class="icon is-small"><i class="fas fa-file-code" aria-hidden="true"></i></span>
<span>从源码安装</span>
</a>
</li>
<li>
<a href="#install-npm">
<span class="icon is-small"><i class="fas fa-cubes" aria-hidden="true"></i></span>
<span>使用NPM安装</span>
</a>
</li>
</ul>
</div>
<div id="install-source" class="tab-content">
从GitHub的仓库中下载源码的压缩包并解压到你Hexo站点的主题目录中。
或者，你可以使用Git来克隆Icarus的代码仓库到`themes`目录下：
{% tabs align:left style:boxed %}
<!-- tab id:install-source 'icon:fas fa-file-code' title:从源码安装 -->
从GitHub的仓库中下载源码的压缩包并解压到你Hexo站点的主题目录中。
或者，你可以使用Git来克隆Icarus的代码仓库到`themes`目录下：
{% codeblock "Git Bash/命令行" %}
git clone https://github.com/ppoffice/hexo-theme-icarus.git themes/icarus -b <version number> --depth 1
{% endcodeblock %}
{% codeblock "Git Bash/命令行" %}
git clone https://github.com/ppoffice/hexo-theme-icarus.git themes/icarus -b <version number> --depth 1
{% endcodeblock %}
你可以省略`-b <version number>`来获取Icarus的最新开发版本。
如果你想同时下载Git仓库的完整提交历史，请同时省略`--depth 1`。
另外，你也可以使用下面的命令将Icarus安装为Git子模块(submodule)：
你可以省略`-b <version number>`来获取Icarus的最新开发版本。
如果你想同时下载Git仓库的完整提交历史，请同时省略`--depth 1`。
另外，你也可以使用下面的命令将Icarus安装为Git子模块(submodule)：
{% codeblock "Git Bash/命令行" %}
git submodule add https://github.com/ppoffice/hexo-theme-icarus.git themes/icarus
{% endcodeblock %}
</div>
{% codeblock "Git Bash/命令行" %}
git submodule add https://github.com/ppoffice/hexo-theme-icarus.git themes/icarus
{% endcodeblock %}
<!-- endtab -->
<div id="install-npm" class="tab-content is-hidden">
若要使用NPM将Icarus安装为Node包，在你的Hexo站点根目录运行如下命令：
<!-- tab active id:install-npm 'icon:fas fa-cubes' title:使用NPM安装 -->
若要使用NPM将Icarus安装为Node包，在你的Hexo站点根目录运行如下命令：
{% codeblock "命令行" %}
npm install -S hexo-theme-icarus
{% endcodeblock %}
</div>
{% codeblock "命令行" %}
npm install -S hexo-theme-icarus hexo-renderer-inferno
{% endcodeblock %}
<!-- endtab -->
{% endtabs %}
<hr>

1
source/_posts/zh-CN/Search-Plugins.md
View File

@ -178,6 +178,7 @@ providers:
{% codeblock _config.icarus.yml lang:yaml %}
search:
type: insight
include_pages: true # 可选项。设置为false时从搜索结果中排除所有page
{% endcodeblock %}

12
source/_posts/zh-CN/Upgrade-Guide.md
View File

@ -19,6 +19,18 @@ toc: true
<!-- more -->
### 从4.x升级至5.x
1. 将Node.js升级到12.4.0或者更新的版本。
2. 下载源代码或者从NPM安装Icarus 5.x。
你可以在{% post_link zh-CN/Getting-Started %}中找到安装指导。
如果你打算通过修改源代码的方式自定义主题，你必须从源代码安装主题。
3. 运行`hexo clean`来清理缓存并让Icarus为你升级主题配置文件。
4. 阅读[更新说明](https://github.com/ppoffice/hexo-theme-icarus/releases)和[最新文档](https://ppoffice.github.io/hexo-theme-icarus/categories/)来了解更多新功能的信息。
### 从3.x升级至4.x
1. 将Node.js升级到10.13.0或者更新的版本。

3
source/_posts/zh-CN/Widgets.md
View File

@ -233,6 +233,9 @@ widgets:
-
position: right
type: tags
order_by: name # 可选项。按名称(name)或长度(length)来排序。加上`-`前缀来倒序排列。
amount: 20 # 可选项。最多显示的标签数量。留空以显示所有标签。
show_count: true # 可选项。是否显示标签名称右侧的文章数量。
{% endcodeblock %}