From 9de04ddaa40b35eddefbfb69a71e48cbe8a69ce8 Mon Sep 17 00:00:00 2001
From: roymondchen <roymondchen@tencent.com>
Date: Sun, 25 Jun 2023 14:40:15 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E5=AE=8C=E5=96=84=E5=BF=AB=E9=80=9F?=
 =?UTF-8?q?=E5=BC=80=E5=A7=8B=E5=AE=9E=E4=BE=8B=E4=BB=A3=E7=A0=81?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .gitignore          |  2 +-
 docs/guide/index.md | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 33 insertions(+), 1 deletion(-)

diff --git a/.gitignore b/.gitignore
index fc1a0b08..e25a0d53 100644
--- a/.gitignore
+++ b/.gitignore
@@ -29,4 +29,4 @@ coverage
 
 auto-imports.d.ts
 components.d.ts
-docs/.vitepress/cache/deps
+docs/.vitepress/cache
diff --git a/docs/guide/index.md b/docs/guide/index.md
index 346fea8c..45d1f09e 100644
--- a/docs/guide/index.md
+++ b/docs/guide/index.md
@@ -121,6 +121,14 @@ app.mount("#app");
 </script>
 
 <style lang="scss">
+  html, body {
+    width: 100%;
+    height: 100%;
+    margin: 0;
+    padding: 0;
+    overflow: hidden;
+  }
+
   #app {
     width: 100%;
     height: 100%;
@@ -138,6 +146,30 @@ app.mount("#app");
 
 其中，**有四个需要注意的属性配置项**：`runtimeUrl` `values` `configs` `componentGroupList`。这是能让我们的编辑器正常运行的关键。
 
+:::tip
+如果出现```Preprocessor dependency "sass" not found. Did you install it?```，那么需要install sass
+
+```bash
+npm install sass -D
+```
+:::
+
+:::tip
+如果是使用vite构建工具，如果出现 ```Uncaught ReferenceError: global is not defined```，那么需要再vite.config.js中添加如下配置：
+
+```js
+{
+  optimizeDeps: {
+    esbuildOptions: {
+      define: {
+        global: 'globalThis',
+      },
+    },
+  },
+}
+```
+:::
+
 ## runtimeUrl
 
 该配置涉及到 [runtime 概念](runtime.md)，tmagic-editor编辑器中心的模拟器画布，是一个 iframe（这里的 `runtimeUrl` 配置的，就是你提供的 iframe 的 url），其中渲染了一个 runtime，用来响应编辑器中的组件增删改等操作。