diff --git a/docs/api/overview.md b/docs/api/overview.md index 71dcad1..ffc0974 100644 --- a/docs/api/overview.md +++ b/docs/api/overview.md @@ -27,8 +27,11 @@ ## 版本信息 部署成功后,直接访问 Base URL,成功时返回 HTML,其中包含类似文案: -```text -CWD 评论部署成功,当前版本... +```json +{ + "version": "0.0.0", + "data": "成功部署 CWD 评论系统 API!文档地址 https://cwd.js.org" +} ``` ## 鉴权方式 diff --git a/docs/guide/backend-config.md b/docs/guide/backend-config.md index a42ce52..ef4651a 100644 --- a/docs/guide/backend-config.md +++ b/docs/guide/backend-config.md @@ -97,8 +97,11 @@ npm install 可以直接访问域名,确认是否部署成功。如果成功,则会显示 -``` -CWD 评论部署成功,当前版本... +```json +{ + "version": "0.0.0", + "data": "成功部署 CWD 评论系统 API!文档地址 https://cwd.js.org" +} ``` ## 环境变量与绑定 diff --git a/docs/guide/frontend-config.md b/docs/guide/frontend-config.md index 2ef6a3c..0badccd 100644 --- a/docs/guide/frontend-config.md +++ b/docs/guide/frontend-config.md @@ -17,9 +17,13 @@ CWD 评论组件采用 **Shadow DOM** 技术构建,基于独立根节点渲染 在初始化 `CWDComments` 实例时,可以传入以下配置参数: +建议使用 cdn 锁版本,防止组件版本升级导致的兼容性问题,更新时只需要修改版本号即可。 + ```html
- + + + ``` +**cdn 链接(推荐使用)** + +``` +https://unpkg.com/cwd-widget@0.0.x/dist/cwd.js +https://cdn.jsdelivr.net/npm/cwd-widget@0.0.x/dist/cwd.js +``` + +*最新版本链接(不建议使用)* +``` +https://cwd.js.org/cwd.js +``` + ### 参数说明 -| 参数 | 类型 | 必填 | 默认值 | 说明 | -| -------------- | ----------------------- | ---- | --------- | ------------------------------------------ | -| `el` | `string \| HTMLElement` | 是 | - | 挂载元素选择器或 DOM 元素 | -| `apiBaseUrl` | `string` | 是 | - | API 基础地址 | -| `theme` | `'light' \| 'dark'` | 否 | `'light'` | 主题模式 | -| `pageSize` | `number` | 否 | `20` | 每页显示评论数 | -| `customCssUrl` | `string` | 否 | - | 自定义样式表 URL,追加到 Shadow DOM 底部 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| -------------- | ----------------------- | ---- | --------- | ---------------------------------------- | +| `el` | `string \| HTMLElement` | 是 | - | 挂载元素选择器或 DOM 元素 | +| `apiBaseUrl` | `string` | 是 | - | API 基础地址 | +| `theme` | `'light' \| 'dark'` | 否 | `'light'` | 主题模式 | +| `pageSize` | `number` | 否 | `20` | 每页显示评论数 | +| `customCssUrl` | `string` | 否 | - | 自定义样式表 URL,追加到 Shadow DOM 底部 | 头像前缀、博主邮箱和标识等信息由后端接口 `/api/config/comments` 提供,无需在前端进行配置。 @@ -80,7 +96,7 @@ comments.updateConfig({ ```html
- + + +