diff --git a/README.zh_CN.md b/README.zh_CN.md index 8d2fa70c..6d02c7b1 100644 --- a/README.zh_CN.md +++ b/README.zh_CN.md @@ -22,7 +22,7 @@ rrweb 是 'record and replay the web' 的简写,旨在利用现代浏览器所 [**📚 rrweb 使用指南 📚**](./guide.zh_CN.md) -[**场景示例**](./docs/receipes/index.zh_CN.md) +[**场景示例**](./docs/recipes/index.zh_CN.md) ## 项目结构 diff --git a/guide.zh_CN.md b/guide.zh_CN.md index e0ce2f33..e7033130 100644 --- a/guide.zh_CN.md +++ b/guide.zh_CN.md @@ -1,6 +1,6 @@ # 使用指南 -> 除通用的使用指南外,你可能还想通过[场景示例](./docs/receipes/index.zh_CN.md)了解特定场景下的使用方式,或是通过[设计文档](./docs)深入 rrweb 的技术细节。 +> 除通用的使用指南外,你可能还想通过[场景示例](./docs/recipes/index.zh_CN.md)了解特定场景下的使用方式,或是通过[设计文档](./docs)深入 rrweb 的技术细节。 ## 安装 @@ -142,8 +142,8 @@ setInterval(save, 10 * 1000); | maskInputOptions | {} | 选择将特定类型的输入框内容记录为 \*
类型详见[列表](https://github.com/rrweb-io/rrweb-snapshot/blob/6728d12b3cddd96951c86d948578f99ada5749ff/src/types.ts#L72) | | inlineStylesheet | true | 是否将样式表内联 | | hooks | {} | 各类事件的回调
类型详见[列表](https://github.com/rrweb-io/rrweb/blob/9488deb6d54a5f04350c063d942da5e96ab74075/src/types.ts#L207) | -| packFn | - | 数据压缩函数,详见[优化存储策略](./docs/receipes/optimize-storage.zh_CN.md) | -| sampling | - | 数据抽样策略,详见[优化存储策略](./docs/receipes/optimize-storage.zh_CN.md) | +| packFn | - | 数据压缩函数,详见[优化存储策略](./docs/recipes/optimize-storage.zh_CN.md) | +| sampling | - | 数据抽样策略,详见[优化存储策略](./docs/recipes/optimize-storage.zh_CN.md) | | recordCanvas | false | 是否记录 canvas 内容 | | collectFonts | false | 是否记录页面中的字体文件 | @@ -286,7 +286,7 @@ replayer.pause(5000); | triggerFocus | true | 回放时是否回放 focus 交互 | | UNSAFE_replayCanvas | false | 回放时是否回放 canvas 内容,**开启后将会关闭沙盒策略,导致一定风险** | | mouseTail | true | 是否在回放时增加鼠标轨迹。传入 false 可关闭,传入对象可以定制轨迹持续时间、样式等,配置详见[类型](https://github.com/rrweb-io/rrweb/blob/9488deb6d54a5f04350c063d942da5e96ab74075/src/types.ts#L407) | -| unpackFn | - | 数据解压缩函数,详见[优化存储策略](./docs/receipes/optimize-storage.zh_CN.md) | +| unpackFn | - | 数据解压缩函数,详见[优化存储策略](./docs/recipes/optimize-storage.zh_CN.md) | #### 使用 rrweb-player