From e6811cf4cdda6a71037660832882b41a45fb6983 Mon Sep 17 00:00:00 2001 From: ZunSThy Date: Fri, 22 Mar 2019 22:07:11 +0800 Subject: [PATCH] fix(docs): remove control character "\x08" in documents (#3) --- README-zh_CN.md | 2 +- packages/griffith-message/README-zh_CN.md | 2 +- packages/griffith-message/README.md | 2 +- packages/griffith/README-zh_CN.md | 4 ++-- packages/griffith/README.md | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README-zh_CN.md b/README-zh_CN.md index 1ff8ae70..036d8bd7 100644 --- a/README-zh_CN.md +++ b/README-zh_CN.md @@ -40,7 +40,7 @@ render() [查看详细使用方法](./packages/griffith/README-zh_CN.md) -**注意：暂不支持 SSR 应用** +**注意：暂不支持 SSR 应用** ### 非 React 应用 diff --git a/packages/griffith-message/README-zh_CN.md b/packages/griffith-message/README-zh_CN.md index c7182097..ce7c083b 100644 --- a/packages/griffith-message/README-zh_CN.md +++ b/packages/griffith-message/README-zh_CN.md @@ -96,6 +96,6 @@ dispatchMessage(targetWindow, messageName, data) | --------------------------------- | -------- | ------------------------------------------------- | ------ | | `ACTIONS.PLAYER.PLAY` | 播放 | `{applyOnFullScreen: boolean}` 是否应用于全屏视频 | TODO | | `ACTIONS.PLAYER.PAUSE` | 暂停 | 同上 | 已支持 | -| `ACTIONS.PLAYER.SET_VOLUME` | 设置音量 | `{volume: number}` 音量值，0 到 1 | TODO | +| `ACTIONS.PLAYER.SET_VOLUME` | 设置音量 | `{volume: number}` 音量值，0 到 1 | TODO | | `ACTIONS.PLAYER.ENTER_FULLSCREEN` | 进入全屏 | 无 | TODO | | `ACTIONS.PLAYER.EXIT_FULLSCREEN` | 退出全屏 | 无 | TODO | diff --git a/packages/griffith-message/README.md b/packages/griffith-message/README.md index af79d1f7..b0c7b15d 100644 --- a/packages/griffith-message/README.md +++ b/packages/griffith-message/README.md @@ -96,6 +96,6 @@ Event sent to the player | --------------------------------- | ---------------- | ----------------------------------------------------------- | ------ | | `ACTIONS.PLAYER.PLAY` | Play | `{applyOnFullScreen: boolean}` Applied to full screen video | TODO | | `ACTIONS.PLAYER.PAUSE` | Pause | Applied to full screen video | ✅ | -| `ACTIONS.PLAYER.SET_VOLUME` | Set the volume | `{volume: number}` Volume value from 0 to 1 | TODO | +| `ACTIONS.PLAYER.SET_VOLUME` | Set the volume | `{volume: number}` Volume value from 0 to 1 | TODO | | `ACTIONS.PLAYER.ENTER_FULLSCREEN` | Enter fullScreen | null | TODO | | `ACTIONS.PLAYER.EXIT_FULLSCREEN` | Exit fullscreen | null | TODO | diff --git a/packages/griffith/README-zh_CN.md b/packages/griffith/README-zh_CN.md index 9a089f83..8f0ecc29 100644 --- a/packages/griffith/README-zh_CN.md +++ b/packages/griffith/README-zh_CN.md @@ -7,7 +7,7 @@ ```bash yarn add griffith yarn add hls.js -# Griffith 播放 M3U8 视频依赖 hls.js。如果不想安装 hls.js，请看 README 的「构建选项」部分。 +# Griffith 播放 M3U8 视频依赖 hls.js。如果不想安装 hls.js，请看 README 的「构建选项」部分。 ``` ```js @@ -58,7 +58,7 @@ standalone 模式下的行为有： - 启用快捷键支持（监听 document 上的 keydown 事件）。 - 会向父级页面发送 message，iframe 所在的页面可以监听这些事件，与播放器进行通信。 -###  与播放器进行跨窗口通信 +### 与播放器进行跨窗口通信 使用 [griffith-message](../packages/griffith-message#README) diff --git a/packages/griffith/README.md b/packages/griffith/README.md index 64e9f2c6..2d86a6d3 100644 --- a/packages/griffith/README.md +++ b/packages/griffith/README.md @@ -58,7 +58,7 @@ The behavior in standalone mode is: - Enable shortcut support (listen to the keydown event on document). - Will send a message to the parent page, the parent page can listen to these events and then communicate with the player. -### Cross-window meesage with player +### Cross-window meesage with player use [griffith-message](../packages/griffith-message#README)