JLNTV_IPD/tmagic-editor
4
0
Fork 0
mirror of https://github.com/Tencent/tmagic-editor.git synced 2025-04-05 19:41:40 +08:00
Code Issues Projects Releases Wiki Activity

docs: 更新文档

Browse Source
This commit is contained in:
roymondchen 2022-06-21 20:53:02 +08:00 committed by jia000
parent 6e7837dc39
commit c2de910f3c
3 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -10,6 +10,8 @@ TMagic 可视化搭建平台。
目前文档仍在逐步完善中，如有疑问欢迎给我们提 issue。 目前文档仍在逐步完善中，如有疑问欢迎给我们提 issue。
[教程](https://tencent.github.io/tmagic-editor/docs/tutorial/hello-world.html)
# Playground 体验 # Playground 体验
https://tencent.github.io/tmagic-editor/playground/index.html https://tencent.github.io/tmagic-editor/playground/index.html

2
docs/src/component/introduction.md
View File

@ -22,7 +22,7 @@ tmagic-editor支持业务方进行自定义组件开发。在tmagic-editor中，
@tmagic/ui 中的 button/text 就是基础的组件示例。我们要求声明 index 入口，因为我们希望在后续的配套打包工具实现上，可以有一个统一规范入口。 @tmagic/ui 中的 button/text 就是基础的组件示例。我们要求声明 index 入口，因为我们希望在后续的配套打包工具实现上，可以有一个统一规范入口。
### 1. 创建组件 ### 1. 创建组件
在项目中，如 runtime vue3 目录中，创建一个名为 test-comopnent 的组件目录，其中包含上面四个规范文件。 在项目中，如 runtime vue3 目录中，创建一个名为 test-component 的组件目录，其中包含上面四个规范文件。
```javascript ```javascript
// index.js // index.js
// vue // vue

4
docs/src/tutorial/runtime.md
View File

@ -143,7 +143,7 @@ devServer: {
这是因为在runtime中无法直接获取到editor中的dsl，所以需要通过editor注入到window的magic api来交互 这是因为在runtime中无法直接获取到editor中的dsl，所以需要通过editor注入到window的magic api来交互
在App.vue中通过监听message，来准备知道magic注入时机，然后调用magic.onRuntimeReady，示例代码如下 在App.vue中通过监听message，来准备获取magic注入时机，然后调用magic.onRuntimeReady，示例代码如下
```ts ```ts
const root = ref(); const root = ref();
@ -201,3 +201,5 @@ watch(page, async () => {
以上就是一个简单runtime实现，以及与编辑的交互，这是一个不完善的实现，但是其中已经几乎覆盖所有需要关心的内容 以上就是一个简单runtime实现，以及与编辑的交互，这是一个不完善的实现，但是其中已经几乎覆盖所有需要关心的内容
当前教程中实现了一个简单的page，tmagic提供了一个比较完善的实现，将在下一节介绍 当前教程中实现了一个简单的page，tmagic提供了一个比较完善的实现，将在下一节介绍
[源码](https://github.com/jia000/tmagic-tutorial/tree/master/course2)