chore: mod readme

heluxjs · Jan 12, 2024 · 78d2b4e · 78d2b4e
1 parent d1a021d
commit 78d2b4e
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -98,7 +98,11 @@ function Demo2() {
 
 ```tsx
 // 只会引起h1标签内部重渲染
-<h1>${numAtom}</h1>
+<h1>{$(numAtom)}</h1>
+
+// 格式化
+<h1>{$(numAtom, num=>`hi helux ${num.val}`)}</h1>
+<h1>{$(numAtom.val, num=>`hi helux ${num}`)}</h1>
 ```
 
 块响应

diff --git a/docs/docs/api/hooks/use-watch-effect.md b/docs/docs/api/hooks/use-watch-effect.md
@@ -4,7 +4,7 @@ order: 4
 
 # useWatchEffect
 
-`useWatchEffect` 功能同 `watchEffect``一样，区别在于 `useWatchEffect` 会立即执行回调，自动对首次运行时函数内读取到的值完成变化监听。
+`useWatchEffect` 功能同 `watchEffect`一样，区别在于 `useWatchEffect` 会立即执行回调，自动对首次运行时函数内读取到的值完成变化监听。
 
 :::info
 其他使用方式可参考[watchEffect](/api/hooks/use-effect)
@@ -46,4 +46,4 @@ export default function Comp(props: any) {
     </div>
   );
 }
-```
+```
diff --git a/docs/tsconfig.json b/docs/tsconfig.json
@@ -12,5 +12,5 @@
       "helux-docs/*": ["src/*", "*"]
     }
   },
-  "include": [".dumirc.ts", "src/**/*"]
+  "include": [".dumirc.ts", "src/**/*", "docs/**/*"]
 }