feat(doc): add docs about Waline comment plugin

pull/865/head
ppoffice 2021-06-27 02:57:39 +00:00
parent a436094780
commit 352beb424f
No known key found for this signature in database
GPG Key ID: D872802C1F2A16AA
3 changed files with 114 additions and 0 deletions

View File

@ -0,0 +1,37 @@
title: Waline Comment Plugin
date: 2015-01-01
tags:
- Demo
comment:
type: waline
server_url: https://icarus-waline-comment.vercel.app
lang: en-US
visitor: false
emoji:
- '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
highlight: true
math_tag_support: false
copyright: true
locale:
placeholder: 'Comment here...'
---
<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>

View File

@ -476,6 +476,45 @@ services until this issue has been fixed.
{% endcodeblock %}
## Waline
<div>
<strong>Installation Guide</strong><a class="tag is-success ml-2" href="{% post_path demo/comment/Waline %}">Preview</a>
</div>
1. Create a LeanCloud application and a Vercel project following the [Get Started](https://waline.js.org/en/guide/get-started.html) guide.
2. Copy the "Server URL" of your Vercel project to the corresponding setting in the theme configurations.
It is usually something like `https://your-domain.vercel.app`.
In addition, you can refer to the [Client Configuration](https://waline.js.org/en/reference/client.html) to find out more
details and possible values of the optional settings.
Here is an example configuration:
{% codeblock _config.icarus.yml lang:yaml %}
comment:
type: waline
server_url: https://your-domain.vercel.app
lang: zh-CN # Optional
visitor: false # Optional
emoji: # Optional
- '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
highlight: true # Optional
math_tag_support: false # Optional
copyright: true # Optional
locale: # Optional
- placeholder: 'Comment here...'
{% endcodeblock %}
<article class="message message-immersive is-warning">
<div class="message-body">
<i class="fas fa-question-circle mr-2"></i>Something wrong with this article?

View File

@ -472,6 +472,44 @@ IP地址 (<a href="https://github.com/xCss/Valine/issues/336" target="_blank" re
{% endcodeblock %}
## Waline
<div>
<strong>安装指南</strong><a class="tag is-success ml-2" href="{% post_path demo/comment/Waline %}">在线预览</a>
</div>
1. 按照[快速上手](https://waline.js.org/guide/get-started.html)创建LeanCloud应用和Vercel项目。
2. 将你Vercel项目的”服务器地址“(Server URL)复制到主题配置的对应配置项中。
通常它类似于`https://your-domain.vercel.app`。
此外,你可以参考[前端配置](https://waline.js.org/reference/client.html)来了解可选配置项的详情和可能的配置值。
下面是示例配置:
{% codeblock _config.icarus.yml lang:yaml %}
comment:
type: waline
server_url: https://your-domain.vercel.app
lang: zh-CN # 可选填
visitor: false # 可选填
emoji: # 可选填
- '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 # 可选填
highlight: true # 可选填
math_tag_support: false # 可选填
copyright: true # 可选填
locale: # 可选填
- placeholder: 'Comment here...'
{% endcodeblock %}
<article class="message message-immersive is-warning">
<div class="message-body">
<i class="fas fa-question-circle mr-2"></i>文章内容有误?请点击<a href="https://github.com/ppoffice/hexo-theme-icarus/edit/site/source/_posts/zh-CN/Comment-Plugins.md">此处</a>提交修改。