Skip to content

Commit d34617c

Browse files
committed
docs: Clarify API usage and parameters in README
1 parent c5c7658 commit d34617c

1 file changed

Lines changed: 34 additions & 23 deletions

File tree

README.md

Lines changed: 34 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -469,7 +469,23 @@ extraApiPluginInfoFinder.isJavaScriptAvailable()
469469

470470
提供文章字数统计功能,支持统计单篇文章或全站文章的字数总和。可选择统计已发布版本或最新版本(含草稿)。适用于显示文章字数、阅读时间估算等场景。
471471

472-
**API 方法**
472+
**API 方法(无参数)**
473+
474+
```javascript
475+
// 统计全部文章已发布版本的总字数
476+
extraApiStatsFinder.getPostWordCount()
477+
```
478+
479+
**参数**
480+
481+
-
482+
483+
**返回值**
484+
485+
- 类型:`int`
486+
- 解释:字数统计结果(非负),不存在或参数缺失时返回 0
487+
488+
**API 方法(传入映射形式参数)**
473489

474490
```javascript
475491
// 传入映射形式参数
@@ -479,11 +495,6 @@ extraApiStatsFinder.getPostWordCount({
479495
})
480496
```
481497

482-
```javascript
483-
// 统计全部文章已发布版本的总字数
484-
extraApiStatsFinder.getPostWordCount()
485-
```
486-
487498
**参数**
488499

489500
- 映射形式参数:
@@ -535,43 +546,43 @@ extraApiStatsFinder.getPostWordCount()
535546

536547
提供 HTML 内容字数统计功能,支持统计任意 HTML 字符串的字数。适用于统计文章内容、瞬间内容或自定义 HTML 片段的字数。
537548

538-
**API 方法**
549+
**API 方法(传入字符串形式参数)**
539550

540551
```javascript
541-
// 传入映射形式参数
542-
extraApiStatsFinder.getContentWordCount({
543-
htmlContent: '<p>HTML 内容</p>' // 必需,要统计字数的 HTML 内容
544-
})
552+
// 直接传入 HTML 内容字符串进行统计
553+
extraApiStatsFinder.getContentWordCount(htmlContent)
545554
```
546555

547556
**参数**
548557

549-
- 映射形式参数:
550-
- `htmlContent`
551-
- 类型:`string`
552-
- 解释:HTML 内容字符串(必需)
558+
- `htmlContent`
559+
- 类型:`string`
560+
- 解释:HTML 内容字符串(必需)。即要统计字数的 HTML 内容,支持标准 HTML 格式。
553561

554562
**返回值**
555563

556-
- 类型:`int`
564+
- 类型:`int`
557565
- 解释:字数统计结果(非负),输入为空时返回 0
558566

559-
**API 方法**
567+
**API 方法(传入映射形式参数)**
560568

561569
```javascript
562-
// 直接传入 HTML 内容字符串进行统计
563-
extraApiStatsFinder.getContentWordCount(htmlContent)
570+
// 传入映射形式参数
571+
extraApiStatsFinder.getContentWordCount({
572+
htmlContent: '<p>HTML 内容</p>' // 必需,要统计字数的 HTML 内容
573+
})
564574
```
565575

566576
**参数**
567577

568-
- `htmlContent`
569-
- 类型:`string`
570-
- 解释:HTML 内容字符串(必需)。即要统计字数的 HTML 内容,支持标准 HTML 格式。
578+
- 映射形式参数:
579+
- `htmlContent`
580+
- 类型:`string`
581+
- 解释:HTML 内容字符串(必需)
571582

572583
**返回值**
573584

574-
- 类型:`int`
585+
- 类型:`int`
575586
- 解释:字数统计结果(非负),输入为空时返回 0
576587

577588
**描述**

0 commit comments

Comments
 (0)