Skip to content

Commit

Permalink
Merge pull request #258 from zh-lx/docs-website-link
Browse files Browse the repository at this point in the history
docs: 更新文档链接
  • Loading branch information
zh-lx authored Jul 8, 2024
2 parents 32e8c35 + 6121e8a commit 8b23041
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -426,7 +426,7 @@

## 3.5.0

- 【feat】新增 `match` api 以支持拼音文本匹配功能。[去看看](/user/match)
- 【feat】新增 `match` api 以支持拼音文本匹配功能。[去看看](/user/match.html)

## 3.4.1

Expand All @@ -435,7 +435,7 @@
## 3.4.0

- 【feat】<b>pinyin</b>:`options` 参数新增 `mode` 可选属性,`options.mode = 'surname'` 模式支持姓氏模式拼音识别。[去看看](/use/pinyin.html#姓氏模式)
- 【feat】新增 `customPinyin` api,支持用户自定义拼音功能。[去看看](/use/customPinyin)
- 【feat】新增 `customPinyin` api,支持用户自定义拼音功能。[去看看](/use/customPinyin.html)
- 【fix】修复文本过长时堆栈溢出问题
- 【patch】修正部分读音:
- 褚: `zhǔ` -> `chǔ zhǔ`
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ npm install pinyin-pro

### 💡 使用示例

全部功能的使用说明文档请查看[在线文档](https://pinyin-pro.cn/use/pinyin)
全部功能的使用说明文档请查看[在线文档](https://pinyin-pro.cn/use/pinyin.html)

- 获取拼音,更多功能请查看[pinyin API](https://pinyin-pro.cn/use/pinyin)
- 获取拼音,更多功能请查看[pinyin API](https://pinyin-pro.cn/use/pinyin.html)

```js
import { pinyin } from "pinyin-pro";
Expand All @@ -69,7 +69,7 @@ npm install pinyin-pro
pinyin("睡着了"); // "shuì zháo le"
```

- 文本和拼音匹配,更多匹配规则请查看[match API](https://pinyin-pro.cn/use/match)
- 文本和拼音匹配,更多匹配规则请查看[match API](https://pinyin-pro.cn/use/match.html)

```js
import { match } from "pinyin-pro";
Expand All @@ -84,7 +84,7 @@ npm install pinyin-pro
match("中文拼音", "zhongwp"); // [0, 1, 2]
```

- 拼音格式转换,更多功能请查看[convert API](https://pinyin-pro.cn/use/convert)
- 拼音格式转换,更多功能请查看[convert API](https://pinyin-pro.cn/use/convert.html)

```js
import { convert } from "pinyin-pro";
Expand All @@ -99,7 +99,7 @@ npm install pinyin-pro
convert("pīn yīn", { format: "toneNone" }); // 'pin yin'
```

- 获取带汉字拼音的 HTML 字符串,更多配置请查看[html API](https://pinyin-pro.cn/use/html)
- 获取带汉字拼音的 HTML 字符串,更多配置请查看[html API](https://pinyin-pro.cn/use/html.html)

```js
import { html } from "pinyin-pro";
Expand Down

0 comments on commit 8b23041

Please sign in to comment.