feat(comment2): make comment pkg optional

vuepress-theme-hope · Oct 26, 2023 · f590ea0 · f590ea0
1 parent d09ab0e
commit f590ea0
Show file tree

Hide file tree

Showing 19 changed files with 388 additions and 40 deletions.
diff --git a/demo/comment2/package.json b/demo/comment2/package.json
@@ -20,7 +20,10 @@
     "@vuepress/core": "2.0.0-beta.67",
     "@vuepress/theme-default": "2.0.0-beta.67",
     "@vuepress/utils": "2.0.0-beta.67",
+    "@waline/client": "2.15.8",
+    "artalk": "2.6.4",
     "sass-loader": "13.3.2",
+    "twikoo": "1.6.22",
     "vue": "3.3.7",
     "vuepress-plugin-comment2": "workspace:*",
     "vuepress-vite": "2.0.0-beta.67",

diff --git a/demo/theme-blog/package.json b/demo/theme-blog/package.json
@@ -20,6 +20,7 @@
     "@vuepress/client": "2.0.0-beta.67",
     "@vuepress/plugin-docsearch": "2.0.0-beta.67",
     "@vuepress/utils": "2.0.0-beta.67",
+    "@waline/client": "2.15.8",
     "chart.js": "4.4.0",
     "echarts": "5.4.3",
     "katex": "0.16.9",

diff --git a/docs/comment2/src/guide/artalk.md b/docs/comment2/src/guide/artalk.md
@@ -9,6 +9,30 @@ Come to your blog, or anywhere, place the Artalk comment box, so that the page h
 
 <!-- more -->
 
+## Install
+
+::: code-tabs#shell
+
+@tab pnpm
+
+```bash
+pnpm add -D artalk
+```
+
+@tab yarn
+
+```bash
+yarn add -D artalk
+```
+
+@tab npm
+
+```bash
+npm i -D artalk
+```
+
+:::
+
 ## Deploy Artalk Server
 
 See the [Artalk documentation](https://artalk.js.org/guide/deploy.html).

diff --git a/docs/comment2/src/guide/twikoo.md b/docs/comment2/src/guide/twikoo.md
@@ -7,6 +7,30 @@ A concise, safe and free static site commenting system, based on [Tencent Cloud
 
 <!-- more -->
 
+## Install
+
+::: code-tabs#shell
+
+@tab pnpm
+
+```bash
+pnpm add -D twikoo
+```
+
+@tab yarn
+
+```bash
+yarn add -D twikoo
+```
+
+@tab npm
+
+```bash
+npm i -D twikoo
+```
+
+:::
+
 ## Getting started
 
 ### Vercel Deployment

diff --git a/docs/comment2/src/guide/waline.md b/docs/comment2/src/guide/waline.md
@@ -3,10 +3,34 @@ title: Waline
 icon: w
 ---
 
-Welcome to Waline. In just a few steps, you can enable Waline to provide comments and page views on your site.
+A safe comment system with backend.
 
 <!-- more -->
 
+## Install
+
+::: code-tabs#shell
+
+@tab pnpm
+
+```bash
+pnpm add -D @waline/client
+```
+
+@tab yarn
+
+```bash
+yarn add -D @waline/client
+```
+
+@tab npm
+
+```bash
+npm i -D @waline/client
+```
+
+:::
+
 ## LeanCloud Settings (Database)
 
 1. [sign in](https://console.leancloud.app/login) or [sign up](https://console.leancloud.app/register) LeanCloud and enter [Console](https://console.leancloud.app/apps).

diff --git a/docs/comment2/src/zh/guide/artalk.md b/docs/comment2/src/zh/guide/artalk.md
@@ -9,6 +9,30 @@ Artalk 是一款简洁的自托管评论系统，你可以在服务器上轻松
 
 <!-- more -->
 
+## 安装
+
+::: code-tabs#shell
+
+@tab pnpm
+
+```bash
+pnpm add -D artalk
+```
+
+@tab yarn
+
+```bash
+yarn add -D artalk
+```
+
+@tab npm
+
+```bash
+npm i -D artalk
+```
+
+:::
+
 ## 部署 Artalk 服务端
 
 请参见 [Artalk 文档](https://artalk.js.org/guide/deploy.html)。

diff --git a/docs/comment2/src/zh/guide/twikoo.md b/docs/comment2/src/zh/guide/twikoo.md
@@ -7,6 +7,30 @@ icon: t
 
 <!-- more -->
 
+## 安装
+
+::: code-tabs#shell
+
+@tab pnpm
+
+```bash
+pnpm add -D twikoo
+```
+
+@tab yarn
+
+```bash
+yarn add -D twikoo
+```
+
+@tab npm
+
+```bash
+npm i -D twikoo
+```
+
+:::
+
 ## 快速上手
 
 部署共有四种方式。

diff --git a/docs/comment2/src/zh/guide/waline.md b/docs/comment2/src/zh/guide/waline.md
@@ -3,10 +3,34 @@ title: Waline
 icon: w
 ---
 
-欢迎使用 Waline，只需几个步骤，你就可以在你的网站中启用 Waline 提供评论与浏览量服务。
+一个有后端的安全评论系统。
 
 <!-- more -->
 
+## 安装
+
+::: code-tabs#shell
+
+@tab pnpm
+
+```bash
+pnpm add -D @waline/client
+```
+
+@tab yarn
+
+```bash
+yarn add -D @waline/client
+```
+
+@tab npm
+
+```bash
+npm i -D @waline/client
+```
+
+:::
+
 ## LeanCloud 设置 (数据库)
 
 1. [登录](https://console.leancloud.app/login) 或 [注册](https://console.leancloud.app/register) `LeanCloud 国际版` 并进入 [控制台](https://console.leancloud.app/apps)

diff --git a/docs/theme/src/guide/feature/comment.md b/docs/theme/src/guide/feature/comment.md
@@ -103,6 +103,28 @@ For other options, see <ProjectLink name="comment2" path="/config/giscus.html">G
 
 ## Waline
 
+::: code-tabs#shell
+
+@tab pnpm
+
+```bash
+pnpm add -D @waline/client
+```
+
+@tab yarn
+
+```bash
+yarn add -D @waline/client
+```
+
+@tab npm
+
+```bash
+npm i -D @waline/client
+```
+
+:::
+
 ### Get APP_ID and APP_Key
 
 [Sign in](https://console.leancloud.app/login) or [sign up](https://console.leancloud.app/register) leancloud. Then create new application in Leancloud, and you will get APP ID / APP Key / APP Master Key.
@@ -166,6 +188,28 @@ For more details, please see [Waline Docs](https://waline.js.org/en/)。
 
 ## Twikoo
 
+::: code-tabs#shell
+
+@tab pnpm
+
+```bash
+pnpm add -D twikoo
+```
+
+@tab yarn
+
+```bash
+yarn add -D twikoo
+```
+
+@tab npm
+
+```bash
+npm i -D twikoo
+```
+
+:::
+
 ### Vercel Deployment
 
 1. Apply for [MongoDB](https://www.mongodb.com/cloud/atlas/register) account
@@ -182,6 +226,28 @@ For more details, please see [Waline Docs](https://waline.js.org/en/)。
 
 ## Artalk
 
+::: code-tabs#shell
+
+@tab pnpm
+
+```bash
+pnpm add -D artalk
+```
+
+@tab yarn
+
+```bash
+yarn add -D artalk
+```
+
+@tab npm
+
+```bash
+npm i -D artalk
+```
+
+:::
+
 ### Deploy Artalk Server
 
 See the [Artalk documentation](https://artalk.js.org/guide/deploy.html) for deploying artalk server.

diff --git a/docs/theme/src/zh/guide/feature/comment.md b/docs/theme/src/zh/guide/feature/comment.md
@@ -105,6 +105,28 @@ Giscus 是一个基于 GitHub Discussion 的评论系统，启用简便。
 
 ## Waline
 
+::: code-tabs#shell
+
+@tab pnpm
+
+```bash
+pnpm add -D @waline/client
+```
+
+@tab yarn
+
+```bash
+yarn add -D @waline/client
+```
+
+@tab npm
+
+```bash
+npm i -D @waline/client
+```
+
+:::
+
 ### 获取 APP ID 和 APP Key
 
 请先 [登录](https://console.leancloud.app/login) 或 [注册](https://console.leancloud.app/register) `LeanCloud 国际版`, 进入 [控制台](https://console.leancloud.app/applist.html#/apps) 后点击左下角 [创建应用](https://console.leancloud.app/applist.html#/newapp)。创建应用后进入该应用，选择左下角的 `设置` > `应用Key`，然后记下 `APP ID`,`APP Key` 和 `Master Key`。
@@ -168,6 +190,28 @@ Waline 评论的其他配置将在 <ProjectLink name="comment2" path="/zh/config
 
 ## Twikoo
 
+::: code-tabs#shell
+
+@tab pnpm
+
+```bash
+pnpm add -D twikoo
+```
+
+@tab yarn
+
+```bash
+yarn add -D twikoo
+```
+
+@tab npm
+
+```bash
+npm i -D twikoo
+```
+
+:::
+
 ### Vercel 部署
 
 [查看视频教程](https://www.bilibili.com/video/BV1Fh411e7ZH)
@@ -186,6 +230,28 @@ Waline 评论的其他配置将在 <ProjectLink name="comment2" path="/zh/config
 
 ## Artalk
 
+::: code-tabs#shell
+
+@tab pnpm
+
+```bash
+pnpm add -D artalk
+```
+
+@tab yarn
+
+```bash
+yarn add -D artalk
+```
+
+@tab npm
+
+```bash
+npm i -D artalk
+```
+
+:::
+
 ### 部署 Artalk 服务端
 
 请参见 [Artalk 文档](https://artalk.js.org/guide/deploy.html)。