diff --git a/site/pages/docs/api.md b/site/pages/docs/api.mdx
similarity index 97%
rename from site/pages/docs/api.md
rename to site/pages/docs/api.mdx
index 45d6450..603259d 100644
--- a/site/pages/docs/api.md
+++ b/site/pages/docs/api.mdx
@@ -4,6 +4,8 @@ title: API参考
type: 开发指南
---
+import { Callout } from "nextra/components";
+
### JavaScript 方法
#### new Pushy(options: PushyOptions)
@@ -98,6 +100,10 @@ interface EventData {
热更相关的工具函数。
+
+注意,在使用 `` 的当前组件(一般是根组件)中无法直接调用`usePushy`,只有当前组件的子组件才能调用。
+
+
```js
const {
checkUpdate,
diff --git a/site/pages/docs/integration.mdx b/site/pages/docs/integration.mdx
index 26b8b21..a18849d 100644
--- a/site/pages/docs/integration.mdx
+++ b/site/pages/docs/integration.mdx
@@ -41,6 +41,8 @@ const pushyClient = new Pushy({
// 在根组件外加上PushyProvider后导出
export default function Root() {
+ // 注意,在使用 PushyProvider 的当前组件中,无法直接调用 usePushy
+ // 只有当前组件的子组件才能调用 usePushy
return (
{/* ↓ 整个应用的根组件放到PushyProvider中 */}