feat(docs): migrate bs docs

2026-04-29 17:23:23 +08:00
parent bf6fc66943
commit 0ccfacbc29
105 changed files with 5537 additions and 243 deletions
--- a/blocksuite/docs-site/.vitepress/config.ts
+++ b/blocksuite/docs-site/.vitepress/config.ts
@@ -0,0 +1,134 @@
+import container from 'markdown-it-container';
+import wasm from 'vite-plugin-wasm';
+import { defineConfig } from 'vitepress';
+import { renderSandbox } from 'vitepress-plugin-sandpack';
+
+import { components, guide, reference } from './sidebar';
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  // FIXME: remove dead links
+  ignoreDeadLinks: true,
+
+  title: 'BlockSuite',
+  description: 'Content Editing Tech Stack for the Web',
+  vite: {
+    build: {
+      target: 'ES2022',
+    },
+    plugins: [
+      wasm(),
+      {
+        name: 'redirect-plugin',
+        configureServer(server) {
+          server.middlewares.use((req, res, next) => {
+            if (req.url === '/blocksuite-overview.html') {
+              res.writeHead(301, { Location: '/guide/overview.html' });
+              res.end();
+            } else {
+              next();
+            }
+          });
+        },
+      },
+    ],
+  },
+  lang: 'en-US',
+  head: [
+    [
+      'link',
+      {
+        rel: 'icon',
+        type: 'image/png',
+        sizes: '32x32',
+        href: 'https://raw.githubusercontent.com/toeverything/blocksuite/master/assets/logo.svg',
+      },
+    ],
+    ['meta', { property: 'twitter:card', content: 'summary_large_image' }],
+    [
+      'meta',
+      {
+        property: 'twitter:image',
+        content:
+          'https://raw.githubusercontent.com/toeverything/blocksuite/master/packages/docs/images/blocksuite-cover.jpg',
+      },
+    ],
+    [
+      'meta',
+      {
+        property: 'og:image',
+        content:
+          'https://raw.githubusercontent.com/toeverything/blocksuite/master/packages/docs/images/blocksuite-cover.jpg',
+      },
+    ],
+  ],
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    outline: [2, 3],
+
+    nav: [
+      {
+        text: 'Components',
+        link: '/components/overview',
+        activeMatch: '/components/*',
+      },
+      {
+        text: 'Framework',
+        link: '/guide/overview',
+        activeMatch: '/guide/*',
+      },
+      {
+        text: 'Playground',
+        link: 'https://try-blocksuite.vercel.app/?init',
+      },
+      {
+        text: 'More',
+        items: [
+          { text: 'Blog', link: '/blog/', activeMatch: '/blog/*' },
+          {
+            text: 'API',
+            link: '/api/',
+            activeMatch: '/api/*',
+          },
+          {
+            text: 'Releases',
+            link: 'https://github.com/toeverything/blocksuite/releases',
+          },
+        ],
+      },
+    ],
+
+    sidebar: {
+      '/guide/': { base: '/', items: guide },
+      '/api/': { base: '/', items: reference },
+      '/components/': { base: '/', items: components },
+    },
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/toeverything/blocksuite' },
+      {
+        icon: {
+          svg: '<svg role="img" xmlns="http://www.w3.org/2000/svg" height="16" width="16" viewBox="0 0 512 512"><!--!Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2023 Fonticons, Inc.--><path fill="#777777" d="M389.2 48h70.6L305.6 224.2 487 464H345L233.7 318.6 106.5 464H35.8L200.7 275.5 26.8 48H172.4L272.9 180.9 389.2 48zM364.4 421.8h39.1L151.1 88h-42L364.4 421.8z"/></svg>',
+        },
+        link: 'https://twitter.com/AffineDev',
+      },
+    ],
+
+    footer: {
+      copyright: 'Copyright © 2022-present Toeverything',
+    },
+
+    search: {
+      provider: 'local',
+    },
+  },
+  markdown: {
+    config(md) {
+      md.use(container, 'code-sandbox', {
+        render(tokens, idx) {
+          return renderSandbox(tokens, idx, 'code-sandbox');
+        },
+      });
+    },
+  },
+});