docs: move all docs into folder

project-sora · Feb 13, 2024 · e186ba5 · e186ba5
1 parent e3d3c22
commit e186ba5
Show file tree

Hide file tree

Showing 34 changed files with 23 additions and 9 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1 @@
-.vitepress/cache
-.vitepress/dist
 node_modules
diff --git a/docs/.vitepress/.gitignore b/docs/.vitepress/.gitignore
@@ -0,0 +1,2 @@
+cache
+dist
diff --git a/.vitepress/config/en.ts → docs/.vitepress/config/en.ts b/.vitepress/config/en.ts → docs/.vitepress/config/en.ts
@@ -1,4 +1,4 @@
-import config from '../../package.json'
+import config from '../../../package.json'
 import { defineConfig, type DefaultTheme } from 'vitepress'
 
 
@@ -63,7 +63,8 @@ function guideReference(): DefaultTheme.SidebarItem[] {
         { text: 'Overview', link: 'editor-overview' },
         { text: 'Getting Started', link: 'getting-started' },
         { text: 'Language', link: 'using-language'},
-        { text: 'Color Scheme', link: 'using-color-scheme' }
+        { text: 'Color Scheme', link: 'using-color-scheme' },
+        { text: 'Events and Components', link: 'events-and-components' }
       ]
     }
   ]

diff --git a/.vitepress/config/index.ts → docs/.vitepress/config/index.ts b/.vitepress/config/index.ts → docs/.vitepress/config/index.ts
diff --git a/.vitepress/config/ja.ts → docs/.vitepress/config/ja.ts b/.vitepress/config/ja.ts → docs/.vitepress/config/ja.ts
@@ -1,4 +1,4 @@
-import config from '../../package.json'
+import config from '../../../package.json'
 import { defineConfig, type DefaultTheme } from 'vitepress'
 
 export const ja = defineConfig({

diff --git a/.vitepress/config/shared.ts → docs/.vitepress/config/shared.ts b/.vitepress/config/shared.ts → docs/.vitepress/config/shared.ts
diff --git a/.vitepress/config/zh.ts → docs/.vitepress/config/zh.ts b/.vitepress/config/zh.ts → docs/.vitepress/config/zh.ts
@@ -1,4 +1,4 @@
-import config from '../../package.json'
+import config from '../../../package.json'
 import { defineConfig, type DefaultTheme } from 'vitepress'
 
 export const zh = defineConfig({

diff --git a/.vitepress/theme/fonts-global.css → docs/.vitepress/theme/fonts-global.css b/.vitepress/theme/fonts-global.css → docs/.vitepress/theme/fonts-global.css
diff --git a/.vitepress/theme/index.ts → docs/.vitepress/theme/index.ts b/.vitepress/theme/index.ts → docs/.vitepress/theme/index.ts
diff --git a/guide/editor-overview.md → docs/guide/editor-overview.md b/guide/editor-overview.md → docs/guide/editor-overview.md
diff --git a/docs/guide/events-and-components.md b/docs/guide/events-and-components.md
@@ -0,0 +1,13 @@
+---
+outline: deep
+---
+# Events and Components
+## Event
+### Type of Events
+### Subscribe Events
+## Components
+### Auto Completion
+### Text Action Window
+### Magnifier
+### Diagnostic Tooltip
+### Context Menu
diff --git a/guide/getting-started.md → docs/guide/getting-started.md b/guide/getting-started.md → docs/guide/getting-started.md
diff --git a/zh/guide/using-color-scheme.md → docs/guide/using-color-scheme.md b/zh/guide/using-color-scheme.md → docs/guide/using-color-scheme.md
diff --git a/guide/using-language.md → docs/guide/using-language.md b/guide/using-language.md → docs/guide/using-language.md
diff --git a/index.md → docs/index.md b/index.md → docs/index.md
diff --git a/ja/guide/editor-overview.md → docs/ja/guide/editor-overview.md b/ja/guide/editor-overview.md → docs/ja/guide/editor-overview.md
diff --git a/ja/guide/getting-started.md → docs/ja/guide/getting-started.md b/ja/guide/getting-started.md → docs/ja/guide/getting-started.md
diff --git a/ja/guide/using-color-scheme.md → docs/ja/guide/using-color-scheme.md b/ja/guide/using-color-scheme.md → docs/ja/guide/using-color-scheme.md
diff --git a/ja/guide/using-language.md → docs/ja/guide/using-language.md b/ja/guide/using-language.md → docs/ja/guide/using-language.md
diff --git a/ja/index.md → docs/ja/index.md b/ja/index.md → docs/ja/index.md
diff --git a/ja/reference/no-implemention.md → docs/ja/reference/no-implemention.md b/ja/reference/no-implemention.md → docs/ja/reference/no-implemention.md
diff --git a/public/editor-banner.jpg → docs/public/editor-banner.jpg b/public/editor-banner.jpg → docs/public/editor-banner.jpg
diff --git a/public/favicon.ico → docs/public/favicon.ico b/public/favicon.ico → docs/public/favicon.ico
diff --git a/public/logo.jpg → docs/public/logo.jpg b/public/logo.jpg → docs/public/logo.jpg
diff --git a/reference/no-implemention.md → docs/reference/no-implemention.md b/reference/no-implemention.md → docs/reference/no-implemention.md
diff --git a/reference/xml-attributes.md → docs/reference/xml-attributes.md b/reference/xml-attributes.md → docs/reference/xml-attributes.md
diff --git a/zh/guide/editor-overview.md → docs/zh/guide/editor-overview.md b/zh/guide/editor-overview.md → docs/zh/guide/editor-overview.md
diff --git a/zh/guide/getting-started.md → docs/zh/guide/getting-started.md b/zh/guide/getting-started.md → docs/zh/guide/getting-started.md
diff --git a/guide/using-color-scheme.md → docs/zh/guide/using-color-scheme.md b/guide/using-color-scheme.md → docs/zh/guide/using-color-scheme.md
diff --git a/zh/guide/using-language.md → docs/zh/guide/using-language.md b/zh/guide/using-language.md → docs/zh/guide/using-language.md
diff --git a/zh/index.md → docs/zh/index.md b/zh/index.md → docs/zh/index.md
diff --git a/zh/reference/no-implemention.md → docs/zh/reference/no-implemention.md b/zh/reference/no-implemention.md → docs/zh/reference/no-implemention.md
diff --git a/zh/reference/xml-attributes.md → docs/zh/reference/xml-attributes.md b/zh/reference/xml-attributes.md → docs/zh/reference/xml-attributes.md
diff --git a/package.json b/package.json
@@ -4,9 +4,9 @@
   "type": "module",
   "description": "documentation for sora-editor",
   "scripts": {
-    "dev": "vitepress dev",
-    "build": "vitepress build",
-    "preview": "vitepress preview"
+    "dev": "vitepress dev docs",
+    "build": "vitepress build docs",
+    "preview": "vitepress preview docs"
   },
   "devDependencies": {
     "markdown-it-mathjax3": "^4.3.2",