chore: 滴滴 1.5 补充文档历史、版本、移动端文档

Author: bflatmajor

README.md

@@ -27,6 +27,7 @@
         <li><a href="/document/gallery.md/">相册</a></li>
         <li><a href="/document/demoscreen.md/">演示模式</a></li>
         <li><a href="/document/shortcut.md/">快捷键</a></li>
+        <li><a href="/document/mobile.md/">移动端</a></li>
       </ul>
     </li>
     <!-- 表格 -->

SUMMARY.md

@@ -20,6 +20,7 @@
   * [mention](document/mention.md)
   * [上传](document/uploader.md)
   * [快捷键](document/shortcut.md)
+  * [移动端](document/mobile.md)
 
 ---
 

document/history.md

@@ -28,6 +28,8 @@ const history = new History({
 
 |名称|类型|默认值|描述|
 | -- | -- | -- | -- |
+| `snapshot` | `string` | 可选 | 获取某条历史快照内容的接口 |
+| `steps` | `string` | 可选 | 按范围获取逐条历史更新内容的接口 |
 | `fetch` | `string` | 可选 | 获取历史列表的接口 |
 | `revert` | `string` | 可选 | 还原某一历史接口 |
 | `user` | `string` | 可选 | 根据id列表获取用户详细信息接口 |

document/mobile.md

@@ -0,0 +1,29 @@
+# 文档移动端插件
+
+加载此插件可以使文档适配移动端网页。
+
+## 构造函数
+
+-   用法
+
+```js
+const Editor = shimo.sdk.document.Editor
+const Mobile = shimo.sdk.document.plugins.Mobile
+const editor = new Editor()
+const mobile = new Mobile({
+    ...options,
+})
+```
+
+-   参数
+
+| 名称          | 类型          | 默认值          | 描述           |
+| ------------- | ------------- | --------------- | -------------- |
+| `editor`      | `Editor`      | 必选            | 编辑器实例     |
+| `container`   | `HTMLElement` | `document.body` | 文档容器       |
+| `editorWrap`  | `HTMLElement` | 必选            | 编辑器容器     |
+| `commentable` | `boolean`     | `false`         | 是否可评论     |
+| `comment`     | `Comment`     | 可选            | 评论插件实例   |
+| `upload`      | `boolean`     | `false`         | 是否支持上传   |
+| `discord`     | `Discord`     | 可选            | 讨论插件实例   |
+| `toolbar`     | `boolean`     | `false`         | 是否启用工具栏 |

document/readme.md

@@ -15,4 +15,5 @@
   <li><a href="/document/mention.md/">mention</a></li>
   <li><a href="/document/uploader.md/">上传</a></li>
   <li><a href="/document/shortcut.md/">快捷键</a></li>
+  <li><a href="/document/mobile.md/">移动端</a></li>
 </ul>

document/revision.md

@@ -32,6 +32,7 @@ const revision = new Revision({
 | `length` | `string` | 可选 | 获取版本列表长度接口 |
 | `fetch` | `string` | 可选 | 获取版本列表接口 |
 | `fetchTitle` | `string` | 可选 | 获取版本标题接口 |
+| `fetchSnapshot` | `string` | 可选 | 获取某版本快照内容接口 |
 | `fetchContent` | `string` | 可选 | 获取版本内容接口 |
 | `generate` | `string` | 可选 | 保存版本接口 |
 | `revert` | `string` | 可选 | 恢复到版本接口 |
@@ -118,4 +119,4 @@ revision.on(Revision.events.ENTER, () => {})
 revision.on(Revision.events.QUIT, () => {})
 // 版本还原成功
 revision.on(Revision.events.REVERT, () => {})
-```
+```