diff --git a/.gitignore b/.gitignore index 49dc7fd..b512c09 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1 @@ -.vitepress/cache -.vitepress/dist node_modules \ No newline at end of file diff --git a/docs/.vitepress/.gitignore b/docs/.vitepress/.gitignore new file mode 100644 index 0000000..0c100c4 --- /dev/null +++ b/docs/.vitepress/.gitignore @@ -0,0 +1,2 @@ +cache +dist \ No newline at end of file diff --git a/.vitepress/config/en.ts b/docs/.vitepress/config/en.ts similarity index 91% rename from .vitepress/config/en.ts rename to docs/.vitepress/config/en.ts index 487e528..ebcb0ac 100644 --- a/.vitepress/config/en.ts +++ b/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 b/docs/.vitepress/config/index.ts similarity index 100% rename from .vitepress/config/index.ts rename to docs/.vitepress/config/index.ts diff --git a/.vitepress/config/ja.ts b/docs/.vitepress/config/ja.ts similarity index 98% rename from .vitepress/config/ja.ts rename to docs/.vitepress/config/ja.ts index 528791d..c7f7e2c 100644 --- a/.vitepress/config/ja.ts +++ b/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 b/docs/.vitepress/config/shared.ts similarity index 100% rename from .vitepress/config/shared.ts rename to docs/.vitepress/config/shared.ts diff --git a/.vitepress/config/zh.ts b/docs/.vitepress/config/zh.ts similarity index 98% rename from .vitepress/config/zh.ts rename to docs/.vitepress/config/zh.ts index c2bf591..f51f7a5 100644 --- a/.vitepress/config/zh.ts +++ b/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 b/docs/.vitepress/theme/fonts-global.css similarity index 100% rename from .vitepress/theme/fonts-global.css rename to docs/.vitepress/theme/fonts-global.css diff --git a/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts similarity index 100% rename from .vitepress/theme/index.ts rename to docs/.vitepress/theme/index.ts diff --git a/guide/editor-overview.md b/docs/guide/editor-overview.md similarity index 100% rename from guide/editor-overview.md rename to docs/guide/editor-overview.md diff --git a/docs/guide/events-and-components.md b/docs/guide/events-and-components.md new file mode 100644 index 0000000..66856d0 --- /dev/null +++ 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 \ No newline at end of file diff --git a/guide/getting-started.md b/docs/guide/getting-started.md similarity index 100% rename from guide/getting-started.md rename to docs/guide/getting-started.md diff --git a/zh/guide/using-color-scheme.md b/docs/guide/using-color-scheme.md similarity index 100% rename from zh/guide/using-color-scheme.md rename to docs/guide/using-color-scheme.md diff --git a/guide/using-language.md b/docs/guide/using-language.md similarity index 100% rename from guide/using-language.md rename to docs/guide/using-language.md diff --git a/index.md b/docs/index.md similarity index 100% rename from index.md rename to docs/index.md diff --git a/ja/guide/editor-overview.md b/docs/ja/guide/editor-overview.md similarity index 100% rename from ja/guide/editor-overview.md rename to docs/ja/guide/editor-overview.md diff --git a/ja/guide/getting-started.md b/docs/ja/guide/getting-started.md similarity index 100% rename from ja/guide/getting-started.md rename to docs/ja/guide/getting-started.md diff --git a/ja/guide/using-color-scheme.md b/docs/ja/guide/using-color-scheme.md similarity index 100% rename from ja/guide/using-color-scheme.md rename to docs/ja/guide/using-color-scheme.md diff --git a/ja/guide/using-language.md b/docs/ja/guide/using-language.md similarity index 100% rename from ja/guide/using-language.md rename to docs/ja/guide/using-language.md diff --git a/ja/index.md b/docs/ja/index.md similarity index 100% rename from ja/index.md rename to docs/ja/index.md diff --git a/ja/reference/no-implemention.md b/docs/ja/reference/no-implemention.md similarity index 100% rename from ja/reference/no-implemention.md rename to docs/ja/reference/no-implemention.md diff --git a/public/editor-banner.jpg b/docs/public/editor-banner.jpg similarity index 100% rename from public/editor-banner.jpg rename to docs/public/editor-banner.jpg diff --git a/public/favicon.ico b/docs/public/favicon.ico similarity index 100% rename from public/favicon.ico rename to docs/public/favicon.ico diff --git a/public/logo.jpg b/docs/public/logo.jpg similarity index 100% rename from public/logo.jpg rename to docs/public/logo.jpg diff --git a/reference/no-implemention.md b/docs/reference/no-implemention.md similarity index 100% rename from reference/no-implemention.md rename to docs/reference/no-implemention.md diff --git a/reference/xml-attributes.md b/docs/reference/xml-attributes.md similarity index 100% rename from reference/xml-attributes.md rename to docs/reference/xml-attributes.md diff --git a/zh/guide/editor-overview.md b/docs/zh/guide/editor-overview.md similarity index 100% rename from zh/guide/editor-overview.md rename to docs/zh/guide/editor-overview.md diff --git a/zh/guide/getting-started.md b/docs/zh/guide/getting-started.md similarity index 100% rename from zh/guide/getting-started.md rename to docs/zh/guide/getting-started.md diff --git a/guide/using-color-scheme.md b/docs/zh/guide/using-color-scheme.md similarity index 100% rename from guide/using-color-scheme.md rename to docs/zh/guide/using-color-scheme.md diff --git a/zh/guide/using-language.md b/docs/zh/guide/using-language.md similarity index 100% rename from zh/guide/using-language.md rename to docs/zh/guide/using-language.md diff --git a/zh/index.md b/docs/zh/index.md similarity index 100% rename from zh/index.md rename to docs/zh/index.md diff --git a/zh/reference/no-implemention.md b/docs/zh/reference/no-implemention.md similarity index 100% rename from zh/reference/no-implemention.md rename to docs/zh/reference/no-implemention.md diff --git a/zh/reference/xml-attributes.md b/docs/zh/reference/xml-attributes.md similarity index 100% rename from zh/reference/xml-attributes.md rename to docs/zh/reference/xml-attributes.md diff --git a/package.json b/package.json index beef71a..89a78df 100644 --- 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",