feat:add docs

2022-12-31 22:27:43 +08:00
parent e8f3b2a6da
commit db52ab815d
17 changed files with 1758 additions and 4 deletions
@@ -0,0 +1,63 @@
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+  base: '/canvas-editor-docs/',
+  title: 'canvas-editor',
+  description: 'rich text editor by canvas/svg',
+  themeConfig: {
+    logo: '/favicon.png',
+    nav: [{
+      text: '指南',
+      link: '/guide/start',
+      activeMatch: '/guide/'
+    }, {
+      text: 'Demo',
+      link: 'https://hufe.club/canvas-editor'
+    }],
+    sidebar: [
+      {
+        text: '开始',
+        items: [
+          { text: '入门', link: '/guide/start' },
+          { text: '配置', link: '/guide/option' },
+          { text: '数据结构', link: '/guide/schema' }
+        ]
+      },
+      {
+        text: '命令',
+        items: [
+          { text: '执行动作命令', link: '/guide/command-execute' },
+          { text: '获取数据命令', link: '/guide/command-get' }
+        ]
+      },
+      {
+        text: '监听',
+        items: [
+          { text: '事件监听', link: '/guide/listener' }
+        ]
+      },
+      {
+        text: '快捷键',
+        items: [
+          { text: '内部快捷键', link: '/guide/shortcut-internal' },
+          { text: '自定义快捷键', link: '/guide/shortcut-custom' },
+        ]
+      },
+      {
+        text: '右键菜单',
+        items: [
+          { text: '内部右键菜单', link: '/guide/contextmenu-internal' },
+          { text: '自定义右键菜单', link: '/guide/contextmenu-custom' }
+        ]
+      }
+    ],
+    socialLinks: [{
+      icon: 'github',
+      link: 'https://github.com/Hufe921/canvas-editor'
+    }],
+    footer: {
+      message: 'Released under the MIT License.',
+      copyright: 'Copyright © 2021-present Hufe'
+    }
+  }
+})