wip: vitepress doc

Author: sakitam-fdd

.eslintrc.cjs

@@ -0,0 +1,6 @@
+module.exports = {
+  root: true,
+  extends: [
+    '@aurorafe/eslint-config-ts',
+  ],
+};

.eslintrc.js

@@ -1,15 +1,5 @@
+const { prettierRules } = require('@aurorafe/eslint-config-base/rules')
+
 module.exports = {
-  printWidth: 100, // 单行长度
-  tabWidth: 2, // 缩进长度
-  useTabs: false, // 使用空格代替tab缩进
-  semi: true, // 句末使用分号
-  singleQuote: true, // 单引号
-  quoteProps: 'as-needed', // 仅在必需时为对象的key添加引号
-  trailingComma: 'all', // 多行时尽可能打印尾随逗号
-  arrowParens: 'always', // 单参数箭头函数参数周围使用圆括号-eg: (x) => x
-  endOfLine: 'lf', // 结束行形式
-  bracketSpacing: true, // 在对象前后添加空格: { foo: bar }
-  jsxSingleQuote: false, // jsx中使用单引号
-  bracketSameLine: false, // 多属性html标签的‘>’折行放置
-  proseWrap: 'never',
+  ...prettierRules,
 };

.prettierrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  root: true,
+  extends: [
+    '@aurorafe/eslint-config-vue',
+  ],
+};

docs/.eslintrc.cjs

@@ -54,25 +54,23 @@ function nav() {
       items: [
         {
           text: 'Changelog',
-          link: 'https://github.com/sakitam-fdd/wind-layer/releases'
+          link: 'https://github.com/sakitam-fdd/wind-layer/releases',
         },
         {
           text: 'Contributing',
-          link: 'https://github.com/sakitam-fdd/wind-layer/blob/master/.github/contributing.md'
-        }
-      ]
-    }
-  ]
+          link: 'https://github.com/sakitam-fdd/wind-layer/blob/master/.github/contributing.md',
+        },
+      ],
+    },
+  ];
 }
 
 function sidebarGuide() {
   return [
     {
       text: 'Introduction',
       collapsible: true,
-      items: [
-        { text: 'Getting Started', link: '/guide/getting-started' },
-      ]
+      items: [{ text: 'Getting Started', link: '/guide/getting-started' }],
     },
     {
       text: 'Cookbook',
@@ -88,29 +86,28 @@ function sidebarGuide() {
         { text: 'ol5', link: '/guide/ol5' },
         { text: 'ol3-4', link: '/guide/openlayers' },
         { text: 'amap', link: '/guide/amap' },
-        { text: 'bmap', link: '/guide/bmap' }
-      ]
+        { text: 'bmap', link: '/guide/bmap' },
+      ],
     },
-  ]
+  ];
 }
 
 const position = {
   false: 'push',
   true: 'unshift',
-}
+};
 
 const renderPermalink = (slug, opts, state, permalink) => {
   try {
-    const tokens = state.tokens
-    const token = tokens[permalink]
+    const tokens = state.tokens;
+    const token = tokens[permalink];
     const title = tokens[permalink + 1].children
       .filter((token) => token.type === 'text' || token.type === 'code_inline')
-      .reduce((acc, t) => acc + t.content, '')
-    const match = /^.+(\s*\{#([a-z0-9\-_]+?)\}\s*)$/.exec(title)
-    slug = match ? match[2] : slug
-    token.attrSet('id', slug)
-    const space = () =>
-      Object.assign(new state.Token('text', '', 0), { content: ' ' })
+      .reduce((acc, t) => acc + t.content, '');
+    const match = /^.+(\s*\{#([a-z0-9\-_]+?)\}\s*)$/.exec(title);
+    slug = match ? match[2] : slug;
+    token.attrSet('id', slug);
+    const space = () => Object.assign(new state.Token('text', '', 0), { content: ' ' });
 
     const linkTokens = [
       Object.assign(new state.Token('link_open', 'a', 1), {
@@ -124,16 +121,14 @@ const renderPermalink = (slug, opts, state, permalink) => {
         content: opts.permalinkSymbol,
       }),
       new state.Token('link_close', 'a', -1),
-    ]
+    ];
     if (opts.permalinkSpace) {
       // @ts-ignore
-      linkTokens[position[!opts.permalinkBefore]](space())
+      linkTokens[position[!opts.permalinkBefore]](space());
     }
-    state.tokens[permalink + 1].children[position[opts.permalinkBefore]](
-      ...linkTokens
-    )
+    state.tokens[permalink + 1].children[position[opts.permalinkBefore]](...linkTokens);
   } catch (e) {}
-}
+};
 
 function getSidebarItems(dir: string[], currentRoot: string | undefined, root: string | undefined): any[] {
   return dir
@@ -145,11 +140,11 @@ function getSidebarItems(dir: string[], currentRoot: string | undefined, root: s
         const fileName = e.split('/').pop() ?? '';
         return items.length
           ? {
-            text: (fileName.charAt(0).toUpperCase() + fileName.slice(1)).replaceAll('-', ' '),
-            collapsible: true,
-            collapsed: true,
-            items,
-          }
+              text: (fileName.charAt(0).toUpperCase() + fileName.slice(1)).replaceAll('-', ' '),
+              collapsible: true,
+              collapsed: true,
+              items,
+            }
           : null!;
       }
       if (e.endsWith('.md') && e[0] !== '_') {
@@ -252,7 +247,7 @@ export default defineConfig({
   themeConfig: {
     editLink: {
       pattern: 'https://github.com/sakitam-fdd/wind-layer/edit/master/docs/:path',
-      text: '在 Github 编辑此页'
+      text: '在 Github 编辑此页',
     },
     nav: nav(),
     sidebar: {
@@ -275,7 +270,7 @@ export default defineConfig({
     },
     footer: {
       message: 'Released under the MIT License.',
-      copyright: 'Copyright © 2022-Present <a href="mailto:[email protected]">sakitam-fdd</a>'
+      copyright: 'Copyright © 2022-Present <a href="mailto:[email protected]">sakitam-fdd</a>',
     },
 
     socialLinks: [
@@ -345,5 +340,17 @@ export default defineConfig({
       prev: '上一篇',
       next: '下一篇',
     },
-  }
-})
+  },
+  // async transformHead(context) {
+  //   // ...
+  //
+  //   console.log(context)
+  // },
+  // transformPageData(pageData) {
+  //   pageData.frontmatter.head ??= []
+  //   pageData.frontmatter.head.push([
+  //     'script',
+  //     { src: '//cdn.jsdelivr.net/npm/maptalks/dist/maptalks.min.js' }
+  //   ])
+  // },
+});

docs/.vitepress/config.ts

@@ -32,7 +32,7 @@ function getDemoComponent(md: any, env, { title, desc, path, code, ...props }: a
       desc="${desc ?? ''}"
       importMap="${encodeURIComponent(importMap)}"
     >
-        <${componentName}></${componentName}>
+      <${componentName}></${componentName}>
     </${DemoTag}>
   `.trim();
 }

docs/.vitepress/plugins/md.ts

@@ -1,22 +1,13 @@
 // @ts-nocheck
+// import { defineClientComponent } from 'vitepress';
 import DefaultTheme from 'vitepress/theme';
 import { SfcPlayground } from '@sakitam-gis/vitepress-playground';
 import '@sakitam-gis/vitepress-playground/dist/style.css';
 import './custom.less';
 
-// 示例组件
-const playgroundModules: Record<string, { default: string }> = import.meta.glob('../../playgrounds/**/*.vue', {
-  eager: true,
-});
-
 export default {
   ...DefaultTheme,
   enhanceApp({ app, router, siteData }) {
     app.component('SfcPlayground', SfcPlayground);
-
-    Object.values(playgroundModules).forEach((module) => {
-      const component = module.default;
-      app.component(component.name, component);
-    });
-  }
-};
+  },
+} as any;

docs/.vitepress/theme/index.ts

@@ -4,8 +4,8 @@
   "type": "module",
   "scripts": {
     "dev": "vitepress dev --base /",
-    "build": "vitepress build --base /wind-layer/",
-    "serve": "vitepress serve docs"
+    "build": "vitepress build --base /",
+    "serve": "vitepress preview"
   },
   "dependencies": {
     "@sakitam-gis/vitepress-playground": "^1.1.3",
@@ -33,7 +33,9 @@
     "fs-extra": "^11.2.0",
     "markdown-it": "^14.0.0",
     "markdown-it-container": "^4.0.0",
-    "vitepress": "^1.0.0-rc.45",
-    "vue": "^3.3.7"
+    "vitepress": "^1.0.2",
+    "vite": "^5.1.3",
+    "vue": "^3.3.7",
+    "vite-plugin-external": "^4.3.0"
   }
 }