docs: add projects (#216)

* docs: add projects * docs(projects): add vue-router * [autofix.ci] apply automated fixes --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
opentiny · Jan 25, 2025 · 909e161 · 909e161
1 parent fd66bb3
commit 909e161
Show file tree

Hide file tree

Showing 21 changed files with 387 additions and 82 deletions.
diff --git a/.github/workflows/auto-deploy.yml b/.github/workflows/auto-deploy.yml
@@ -7,6 +7,7 @@ on:
     branches: [main]
     paths:
       - 'packages/docs/**'
+      - 'packages/projects/**'
       - '!packages/docs/**/*.spec.ts'
 
   # Allows you to run this workflow manually from the Actions tab
@@ -38,6 +39,8 @@ jobs:
         run: pnpm i --no-frozen-lockfile
       - name: Build site
         run: pnpm build
+      - name: Build projects
+        run: pnpm build:projects
       - name: Setup Pages
         uses: actions/configure-pages@v2
       - name: Build with Jekyll

diff --git a/package.json b/package.json
@@ -26,7 +26,9 @@
   ],
   "scripts": {
     "dev": "pnpm -F docs dev",
+    "dev:projects": "pnpm -F projects dev",
     "build": "pnpm -F docs build",
+    "build:projects": "pnpm -F projects build",
     "build:lib": "pnpm -F @opentiny/fluent-editor build",
     "lint": "eslint . --cache",
     "lint:fix": "eslint . --fix",

diff --git a/packages/projects/.gitignore b/packages/projects/.gitignore
@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
diff --git a/packages/projects/.vscode/extensions.json b/packages/projects/.vscode/extensions.json
@@ -0,0 +1,3 @@
+{
+  "recommendations": ["Vue.volar"]
+}
diff --git a/packages/projects/README.md b/packages/projects/README.md
@@ -0,0 +1,5 @@
+# Vue 3 + TypeScript + Vite
+
+This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+
+Learn more about the recommended Project Setup and IDE Support in the [Vue Docs TypeScript Guide](https://vuejs.org/guide/typescript/overview.html#project-setup).
diff --git a/packages/projects/index.html b/packages/projects/index.html
@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Vite + Vue + TS</title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.ts"></script>
+  </body>
+</html>
diff --git a/packages/projects/package.json b/packages/projects/package.json
@@ -0,0 +1,23 @@
+{
+  "name": "projects",
+  "type": "module",
+  "version": "0.0.0",
+  "private": true,
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "@opentiny/fluent-editor": "workspace:^",
+    "vue": "^3.5.13",
+    "vue-router": "4"
+  },
+  "devDependencies": {
+    "@vitejs/plugin-vue": "^5.2.1",
+    "@vue/tsconfig": "^0.7.0",
+    "typescript": "~5.6.2",
+    "vite": "^6.0.5",
+    "vue-tsc": "^2.2.0"
+  }
+}
diff --git a/packages/projects/public/vite.svg b/packages/projects/public/vite.svg
diff --git a/packages/projects/src/App.vue b/packages/projects/src/App.vue
@@ -0,0 +1,3 @@
+<template>
+  <RouterView />
+</template>
diff --git a/packages/projects/src/assets/vue.svg b/packages/projects/src/assets/vue.svg
diff --git a/packages/projects/src/components/NotFound.vue b/packages/projects/src/components/NotFound.vue
@@ -0,0 +1,3 @@
+<template>
+  <div>Not Found</div>
+</template>
diff --git a/packages/projects/src/main.ts b/packages/projects/src/main.ts
@@ -0,0 +1,22 @@
+import { createApp } from 'vue'
+import { createRouter, createWebHistory } from 'vue-router'
+import App from './App.vue'
+import NotFoundComponent from './components/NotFound.vue'
+import HomeView from './views/home/Home.vue'
+import YuQueView from './views/yuque/YuQue.vue'
+import './style.css'
+
+const routes = [
+  { path: '/', component: HomeView },
+  { path: '/yuque', component: YuQueView },
+  { path: '/:pathMatch(.*)', component: NotFoundComponent },
+]
+
+const router = createRouter({
+  history: createWebHistory('/tiny-editor/projects'),
+  routes,
+})
+
+router.addRoute({ path: '/', component: HomeView })
+
+createApp(App).use(router).mount('#app')
diff --git a/packages/projects/src/style.css b/packages/projects/src/style.css
@@ -0,0 +1 @@
+@import '@opentiny/fluent-editor/style.scss';
diff --git a/packages/projects/src/views/home/Home.vue b/packages/projects/src/views/home/Home.vue
@@ -0,0 +1,9 @@
+<template>
+  <ul>
+    <li>
+      <RouterLink to="/yuque">
+        语雀
+      </RouterLink>
+    </li>
+  </ul>
+</template>
diff --git a/packages/projects/src/views/yuque/YuQue.vue b/packages/projects/src/views/yuque/YuQue.vue
@@ -0,0 +1,21 @@
+<script setup lang="ts">
+import FluentEditor from '@opentiny/fluent-editor'
+import { onMounted } from 'vue'
+
+let editor
+
+onMounted(() => {
+  editor = new FluentEditor('#editor', {
+    theme: 'snow',
+  })
+})
+</script>
+
+<template>
+  <RouterLink to="/">
+    &lt;返回
+  </RouterLink>
+  <div id="editor">
+    <p>Hello <strong>TinyEditor</strong>!</p>
+  </div>
+</template>
diff --git a/packages/projects/src/vite-env.d.ts b/packages/projects/src/vite-env.d.ts
@@ -0,0 +1 @@
+/// <reference types="vite/client" />
diff --git a/packages/projects/tsconfig.app.json b/packages/projects/tsconfig.app.json
@@ -0,0 +1,14 @@
+{
+  "extends": "@vue/tsconfig/tsconfig.dom.json",
+  "compilerOptions": {
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
+
+    /* Linting */
+    "strict": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noUncheckedSideEffectImports": true
+  },
+  "include": ["src/**/*.ts", "src/**/*.tsx", "src/**/*.vue"]
+}
diff --git a/packages/projects/tsconfig.json b/packages/projects/tsconfig.json
@@ -0,0 +1,7 @@
+{
+  "references": [
+    { "path": "./tsconfig.app.json" },
+    { "path": "./tsconfig.node.json" }
+  ],
+  "files": []
+}
diff --git a/packages/projects/tsconfig.node.json b/packages/projects/tsconfig.node.json
@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
+    "target": "ES2022",
+    "lib": ["ES2023"],
+    "moduleDetection": "force",
+    "module": "ESNext",
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+
+    /* Linting */
+    "strict": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noEmit": true,
+    "isolatedModules": true,
+    "skipLibCheck": true,
+    "noUncheckedSideEffectImports": true
+  },
+  "include": ["vite.config.ts"]
+}
diff --git a/packages/projects/vite.config.ts b/packages/projects/vite.config.ts
@@ -0,0 +1,20 @@
+import path from 'node:path'
+import vue from '@vitejs/plugin-vue'
+import { defineConfig } from 'vite'
+
+const fluentEditorRoot = path.resolve(__dirname, '../fluent-editor')
+export default defineConfig({
+  base: '/tiny-editor/projects/',
+  plugins: [vue()],
+  resolve: {
+    alias: [
+      {
+        find: '@opentiny/fluent-editor/style.scss',
+        replacement: path.resolve(fluentEditorRoot, 'src/assets/style.scss'),
+      },
+    ],
+  },
+  build: {
+    outDir: '../docs/fluent-editor/.vitepress/dist/projects',
+  },
+})