From c2de910f3c36b8330798787b27fceeb6e0abc8a3 Mon Sep 17 00:00:00 2001 From: roymondchen Date: Tue, 21 Jun 2022 20:53:02 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 ++ docs/src/component/introduction.md | 2 +- docs/src/tutorial/runtime.md | 4 +++- 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 519db98a..50078813 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,8 @@ TMagic 可视化搭建平台。 目前文档仍在逐步完善中，如有疑问欢迎给我们提 issue。 +[教程](https://tencent.github.io/tmagic-editor/docs/tutorial/hello-world.html) + # Playground 体验 https://tencent.github.io/tmagic-editor/playground/index.html diff --git a/docs/src/component/introduction.md b/docs/src/component/introduction.md index 4b8a9a39..5935b894 100644 --- a/docs/src/component/introduction.md +++ b/docs/src/component/introduction.md @@ -22,7 +22,7 @@ tmagic-editor支持业务方进行自定义组件开发。在tmagic-editor中， @tmagic/ui 中的 button/text 就是基础的组件示例。我们要求声明 index 入口，因为我们希望在后续的配套打包工具实现上，可以有一个统一规范入口。 ### 1. 创建组件 -在项目中，如 runtime vue3 目录中，创建一个名为 test-comopnent 的组件目录，其中包含上面四个规范文件。 +在项目中，如 runtime vue3 目录中，创建一个名为 test-component 的组件目录，其中包含上面四个规范文件。 ```javascript // index.js // vue diff --git a/docs/src/tutorial/runtime.md b/docs/src/tutorial/runtime.md index c15f3ce7..da1d3455 100644 --- a/docs/src/tutorial/runtime.md +++ b/docs/src/tutorial/runtime.md @@ -143,7 +143,7 @@ devServer: { 这是因为在runtime中无法直接获取到editor中的dsl，所以需要通过editor注入到window的magic api来交互 -在App.vue中通过监听message，来准备知道magic注入时机，然后调用magic.onRuntimeReady，示例代码如下 +在App.vue中通过监听message，来准备获取magic注入时机，然后调用magic.onRuntimeReady，示例代码如下 ```ts const root = ref(); @@ -201,3 +201,5 @@ watch(page, async () => { 以上就是一个简单runtime实现，以及与编辑的交互，这是一个不完善的实现，但是其中已经几乎覆盖所有需要关心的内容 当前教程中实现了一个简单的page，tmagic提供了一个比较完善的实现，将在下一节介绍 + +[源码](https://github.com/jia000/tmagic-tutorial/tree/master/course2)