shumengya/cwd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: 更新文档中的版本检查响应与前端CDN链接

Browse Source 
- 将部署成功时的版本检查响应从纯文本改为JSON格式，包含版本号和部署成功信息
- 更新前端配置指南，推荐使用版本锁定的CDN链接替代最新版本链接
- 统一修改所有示例代码中的CDN引用，添加版本控制说明
- 调整表格格式以保持一致性
This commit is contained in:
anghunk
2026-01-31 12:24:01 +08:00
parent 52781a3ca4
commit d060cf20da
3 changed files with 38 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/api/overview.md
View File

@@ -27,8 +27,11 @@
## 版本信息 ## 版本信息
部署成功后，直接访问 Base URL，成功时返回 HTML，其中包含类似文案： 部署成功后，直接访问 Base URL，成功时返回 HTML，其中包含类似文案：
```text ```json
CWD 评论部署成功，当前版本... {
"version": "0.0.0",
"data": "成功部署 CWD 评论系统 API！文档地址 https://cwd.js.org"
}
``` ```
## 鉴权方式 ## 鉴权方式

7
docs/guide/backend-config.md
View File

@@ -97,8 +97,11 @@ npm install
可以直接访问域名，确认是否部署成功。如果成功，则会显示 可以直接访问域名，确认是否部署成功。如果成功，则会显示
``` ```json
CWD 评论部署成功，当前版本... {
"version": "0.0.0",
"data": "成功部署 CWD 评论系统 API！文档地址 https://cwd.js.org"
}
``` ```
## 环境变量与绑定 ## 环境变量与绑定

39
docs/guide/frontend-config.md
View File

@@ -17,9 +17,13 @@ CWD 评论组件采用 **Shadow DOM** 技术构建，基于独立根节点渲染
在初始化 `CWDComments` 实例时，可以传入以下配置参数： 在初始化 `CWDComments` 实例时，可以传入以下配置参数：
建议使用 cdn 锁版本，防止组件版本升级导致的兼容性问题，更新时只需要修改版本号即可。
```html ```html
<div id="comments"></div> <div id="comments"></div>
<script src="https://cwd.js.org/cwd.js"></script> <script src="https://unpkg.com/cwd-widget@0.0.x/dist/cwd.js"></script>
<!-- <script src="https://cdn.jsdelivr.net/npm/cwd-widget@0.0.x/dist/cwd.js"></script> -->
<script> <script>
const comments = new CWDComments({ const comments = new CWDComments({
el: '#comments', el: '#comments',
@@ -29,15 +33,27 @@ CWD 评论组件采用 **Shadow DOM** 技术构建，基于独立根节点渲染
</script> </script>
``` ```
**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 元素 | | `el` | `string \| HTMLElement` | 是 | - | 挂载元素选择器或 DOM 元素 |
| `apiBaseUrl` | `string` | 是 | - | API 基础地址 | | `apiBaseUrl` | `string` | 是 | - | API 基础地址 |
| `theme` | `'light' \| 'dark'` | 否 | `'light'` | 主题模式 | | `theme` | `'light' \| 'dark'` | 否 | `'light'` | 主题模式 |
| `pageSize` | `number` | 否 | `20` | 每页显示评论数 | | `pageSize` | `number` | 否 | `20` | 每页显示评论数 |
| `customCssUrl` | `string` | 否 | - | 自定义样式表 URL，追加到 Shadow DOM 底部 | | `customCssUrl` | `string` | 否 | - | 自定义样式表 URL，追加到 Shadow DOM 底部 |
头像前缀、博主邮箱和标识等信息由后端接口 `/api/config/comments` 提供，无需在前端进行配置。 头像前缀、博主邮箱和标识等信息由后端接口 `/api/config/comments` 提供，无需在前端进行配置。
@@ -80,7 +96,7 @@ comments.updateConfig({
```html ```html
<div id="comments"></div> <div id="comments"></div>
<script src="https://cwd.js.org/cwd.js"></script> <script src="https://unpkg.com/cwd-widget@0.0.x/dist/cwd.js"></script>
<!-- 实例调用 --> <!-- 实例调用 -->
<script> <script>
@@ -105,7 +121,8 @@ comments.updateConfig({
```astro ```astro
<div id="comments"></div> <div id="comments"></div>
<script src="https://cwd.js.org/cwd.js" is:inline></script> <script src="https://unpkg.com/cwd-widget@0.0.x/dist/cwd.js" is:inline></script>
<script is:inline> <script is:inline>
document.addEventListener('DOMContentLoaded', () => { document.addEventListener('DOMContentLoaded', () => {
const comments = new window.CWDComments({ const comments = new window.CWDComments({
@@ -136,7 +153,7 @@ comments.updateConfig({
onMounted(async () => { onMounted(async () => {
if (!window.CWDComments) { if (!window.CWDComments) {
await loadScript('https://cwd.js.org/cwd.js'); await loadScript('https://unpkg.com/cwd-widget@0.0.x/dist/cwd.js');
} }
instance = new window.CWDComments({ instance = new window.CWDComments({