docs

red-axe · Jun 15, 2022 · 104eab5 · 104eab5
1 parent 2a14483
commit 104eab5
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 7 deletions.
diff --git a/docs/config/index.md b/docs/config/index.md
@@ -20,7 +20,7 @@ const engine = new Engine(render node, {
 -   Detailed: Language configuration, temporarily supports `zh-CN`, `en-US`. Can use `locale` configuration
 
 ```ts
-const view = new View(render node, {
+const engine = new Engine(render node, {
     lang:'zh-CN',
 });
 ```
@@ -34,7 +34,7 @@ const view = new View(render node, {
 Language pack, default language pack [https://github.com/yanmao-cc/am-editor/blob/master/locale](https://github.com/yanmao-cc/am-editor/blob/master/locale)
 
 ```ts
-const view = new View(render node, {
+const engine = new Engine(render node, {
      locale: {
          'zh-CN': {
              test:'Test',
@@ -44,7 +44,7 @@ const view = new View(render node, {
          },
      }
 });
-console.log(view.language.get<string>('test'));
+console.log(engine.language.get<string>('test'));
 ```
 
 ### className
@@ -240,6 +240,18 @@ After rendering, `View` loses all editing capabilities and collaboration capabil
 -   Default: `url('//at.alicdn.com/t/font_1456030_lnqmc6a6ca.woff2?t=1638071536645') format('woff2'), url('//at.alicdn.com/t/font_1456030_lnqmc6a6ca.woff ?t=1638071536645') format('woff'), url('//at.alicdn.com/t/font_1456030_lnqmc6a6ca.ttf?t=1638071536645') format('truetype')`
 -   Detailed: define the url of the iconfont file, the font file of at.alicdn.com is used by default, if you need to use the font file of other location, you can use this configuration
 
+```ts
+const engine = new Engine(container, {
+	iconFonts: {
+		url: '//at.alicdn.com/t/font_1456030_lnqmc6a6ca.woff2?t=1638071536645',
+		format: 'woff2',
+	},
+	// or
+	iconFonts:
+		"url('//at.alicdn.com/t/font_1456030_lnqmc6a6ca.woff2?t=1638071536645') format('woff2'), url('//at.alicdn.com/t/font_1456030_lnqmc6a6ca.woff?t=1638071536645') format('woff'), url('//at.alicdn.com/t/font_1456030_lnqmc6a6ca.ttf?t=1638071536645') format('truetype')",
+});
+```
+
 ### autoPrepend
 
 -   type: `boolean`

diff --git a/docs/config/index.zh-CN.md b/docs/config/index.zh-CN.md
@@ -20,7 +20,7 @@ const engine = new Engine(渲染节点, {
 -   详细：语言配置，暂时支持 `zh-CN`、`en-US`。可使用 `locale` 配置
 
 ```ts
-const view = new View(渲染节点, {
+const engine = new Engine(渲染节点, {
 	lang: 'zh-CN',
 });
 ```
@@ -34,7 +34,7 @@ const view = new View(渲染节点, {
 语言包，默认语言包 [https://github.com/yanmao-cc/am-editor/blob/master/locale](https://github.com/yanmao-cc/am-editor/blob/master/locale)
 
 ```ts
-const view = new View(渲染节点, {
+const engine = new Engine(渲染节点, {
 	locale: {
 		'zh-CN': {
 			test: '测试',
@@ -44,7 +44,7 @@ const view = new View(渲染节点, {
 		},
 	},
 });
-console.log(view.language.get<string>('test'));
+console.log(engine.language.get<string>('test'));
 ```
 
 ### className
@@ -228,18 +228,36 @@ console.log(view.language.get<string>('test'));
 -   默认值：查找父级样式 `overflow` 或者 `overflow-y` 为 `auto` 或者 `scroll` 的节点，如果没有就取 `document.documentElement`
 -   详细：编辑器滚动条节点，主要用于监听 `scroll` 事件设置弹层浮动位置和主动设置滚动到编辑器目标位置
 
+或者使用 `setScrollNode` 设置
+
+```ts
+engine.setScrollNode(滚动条节点);
+```
+
 ### lazyRender
 
 -   类型: `boolena`
 -   默认值：`true`
--   详细：懒惰渲染卡片（仅限已启用 lazyRender 的卡片），默认为 true
+-   详细：懒惰渲染卡片（仅限已启用 lazyRender 的卡片），默认为 true。协同状态下可编辑卡片不会懒惰渲染
 
 ### iconFonts
 
 -   类型: `Record<'url' | 'format', string>[] | string | false`
 -   默认值：`url('//at.alicdn.com/t/font_1456030_lnqmc6a6ca.woff2?t=1638071536645') format('woff2'), url('//at.alicdn.com/t/font_1456030_lnqmc6a6ca.woff?t=1638071536645') format('woff'), url('//at.alicdn.com/t/font_1456030_lnqmc6a6ca.ttf?t=1638071536645') format('truetype')`
 -   详细：定义 iconfont 文件的 url，默认使用 at.alicdn.com 的字体文件，如果需要使用其他位置的字体文件，可以使用此配置
 
+```ts
+const engine = new Engine(渲染节点, {
+	iconFonts: {
+		url: '//at.alicdn.com/t/font_1456030_lnqmc6a6ca.woff2?t=1638071536645',
+		format: 'woff2',
+	},
+	// or
+	iconFonts:
+		"url('//at.alicdn.com/t/font_1456030_lnqmc6a6ca.woff2?t=1638071536645') format('woff2'), url('//at.alicdn.com/t/font_1456030_lnqmc6a6ca.woff?t=1638071536645') format('woff'), url('//at.alicdn.com/t/font_1456030_lnqmc6a6ca.ttf?t=1638071536645') format('truetype')",
+});
+```
+
 ### autoPrepend
 
 -   类型：`boolean`