update：update docs

Author: sakitam-fdd

docs/.vitepress/config.ts

@@ -81,9 +81,9 @@ function sidebarGuide() {
         { text: 'data', link: '/guide/data' },
         { text: 'maptalks', link: '/guide/maptalks' },
         { text: 'mapbox-gl', link: '/guide/mapbox-gl' },
+        { text: 'maplibre-gl', link: '/guide/maplibre-gl' },
         { text: 'leaflet', link: '/guide/leaflet' },
         { text: 'ol', link: '/guide/ol' },
-        { text: 'ol5', link: '/guide/ol5' },
         { text: 'ol3-4', link: '/guide/openlayers' },
         { text: 'amap', link: '/guide/amap' },
         { text: 'bmap', link: '/guide/bmap' },
@@ -102,7 +102,7 @@ const renderPermalink = (slug, opts, state, permalink) => {
     const tokens = state.tokens;
     const token = tokens[permalink];
     const title = tokens[permalink + 1].children
-      .filter((token) => token.type === 'text' || token.type === 'code_inline')
+      .filter((t: any) => t.type === 'text' || t.type === 'code_inline')
       .reduce((acc, t) => acc + t.content, '');
     const match = /^.+(\s*\{#([a-z0-9\-_]+?)\}\s*)$/.exec(title);
     slug = match ? match[2] : slug;
@@ -123,11 +123,13 @@ const renderPermalink = (slug, opts, state, permalink) => {
       new state.Token('link_close', 'a', -1),
     ];
     if (opts.permalinkSpace) {
-      // @ts-ignore
+      // @ts-ignore ignore error
       linkTokens[position[!opts.permalinkBefore]](space());
     }
     state.tokens[permalink + 1].children[position[opts.permalinkBefore]](...linkTokens);
-  } catch (e) {}
+  } catch (e) {
+    //
+  }
 };
 
 function getSidebarItems(dir: string[], currentRoot: string | undefined, root: string | undefined): any[] {
@@ -140,6 +142,7 @@ function getSidebarItems(dir: string[], currentRoot: string | undefined, root: s
         const fileName = e.split('/').pop() ?? '';
         return items.length
           ? {
+              // @ts-ignore ignore error
               text: (fileName.charAt(0).toUpperCase() + fileName.slice(1)).replaceAll('-', ' '),
               collapsible: true,
               collapsed: true,
@@ -149,6 +152,7 @@ function getSidebarItems(dir: string[], currentRoot: string | undefined, root: s
       }
       if (e.endsWith('.md') && e[0] !== '_') {
         return {
+          // @ts-ignore ignore error
           text: (e.charAt(0).toUpperCase() + e.slice(1)).slice(0, -3).replaceAll('-', ' '),
           link: childDir.replace(root ?? '', ''),
         };
@@ -164,10 +168,11 @@ function autoSidebar(dirs: string[]): SidebarItem[] {
   return getSidebarItems(dirs, root, root);
 }
 
-function sidebar(root = '', packagesPath: string) {
+function sidebar(root = '', packagesPath = '') {
   const index: { [key: string]: { text: string; link: string }[] } = {};
   const mds = readFileSync(`${__dirname}/../${packagesPath}/index.md`, 'utf-8').match(/.*.(\n|\r)/g) as string[];
   let lastTitle = '';
+  // eslint-disable-next-line no-restricted-syntax
   for (const line of mds) {
     if (line.match(/# @/)) continue;
     else if (line.match(/##\s\w+/)) {
@@ -193,6 +198,7 @@ function sidebar(root = '', packagesPath: string) {
     },
   ];
 
+  // eslint-disable-next-line no-restricted-syntax
   for (const i in index) {
     s.push({
       text: i,
@@ -286,7 +292,7 @@ export default defineConfig({
       provider: 'algolia',
       options: {
         appId: '7HSJME72X5',
-        apiKey: 'b7a68c2706d9d2053ce96743b17c829b',
+        apiKey: 'f907bba98e6918b124db4596143784dd',
         indexName: 'wind-layer',
         searchParameters: {
           facetFilters: ['tags:latest'],

docs/.vitepress/plugins/md.ts

@@ -10,7 +10,7 @@ const scriptLangTsRE = /<\s*script[^>]*\blang=['"]ts['"][^>]*/;
 const scriptSetupRE = /<\s*script[^>]*\bsetup\b[^>]*/;
 const scriptClientRE = /<\s*script[^>]*\bclient\b[^>]*/;
 let index = 1;
-function getDemoComponent(md: any, env, { title, desc, path, code, ...props }: any) {
+function getDemoComponent(md: any, env: any, { title, desc, path, code, enableIntersectionObserver, ...props }: any) {
   const componentName = `DemoComponent${index++}`;
   path = normalizePath(path);
   injectImportStatement(env, componentName, path);
@@ -30,6 +30,7 @@ function getDemoComponent(md: any, env, { title, desc, path, code, ...props }: a
       src="${path}"
       title="${title ?? ''}"
       desc="${desc ?? ''}"
+      enableIntersectionObserver="${enableIntersectionObserver ?? 'true'}"
       importMap="${encodeURIComponent(importMap)}"
     >
       <${componentName}></${componentName}>
@@ -58,39 +59,34 @@ function genDemoByCode(md: any, env: any, path: string, code: string) {
 }
 
 function injectImportStatement(env: any, componentName: string, path: string) {
-  const componentRegistStatement =
-    `import ${componentName} from '${path}'`.trim()
+  const componentRegistStatement = `import ${componentName} from '${path}'`.trim();
 
   if (!env?.sfcBlocks?.scripts) {
-    env.sfcBlocks.scripts = []
+    env.sfcBlocks.scripts = [];
   }
-  const tags = env.sfcBlocks.scripts as { content: string }[]
+  const tags = env.sfcBlocks.scripts as { content: string }[];
 
-  const isUsingTS = tags.findIndex(tag => scriptLangTsRE.test(tag.content)) > -1
-  const existingSetupScriptIndex = tags?.findIndex(tag => {
-    return (
-      scriptRE.test(tag.content) &&
-      scriptSetupRE.test(tag.content) &&
-      !scriptClientRE.test(tag.content)
-    )
-  })
+  const isUsingTS = tags.findIndex((tag) => scriptLangTsRE.test(tag.content)) > -1;
+  const existingSetupScriptIndex = tags?.findIndex(
+    (tag) => scriptRE.test(tag.content) && scriptSetupRE.test(tag.content) && !scriptClientRE.test(tag.content),
+  );
 
   if (existingSetupScriptIndex > -1) {
-    const tagSrc = tags[existingSetupScriptIndex]
+    const tagSrc = tags[existingSetupScriptIndex];
     tags[existingSetupScriptIndex].content = tagSrc.content.replace(
       scriptRE,
       `${componentRegistStatement}
 
       </script>`,
-    )
+    );
   } else {
     tags.unshift({
       content: `
         <script ${isUsingTS ? 'lang="ts"' : ''} setup >
           ${componentRegistStatement}
         </script>
       `.trim(),
-    })
+    });
   }
 }
 
@@ -102,7 +98,7 @@ function demoBlockPlugin(md: any) {
   const addRenderRule = (type: string) => {
     const defaultRender = md.renderer.rules[type];
 
-    md.renderer.rules[type] = (tokens: any, idx: string, options, env, ...args: any[]) => {
+    md.renderer.rules[type] = (tokens: any, idx: string, options: any, env: any, ...args: any[]) => {
       const token = tokens[idx];
       const content = token.content.trim();
       if (!content.startsWith(`<${DemoTag} `)) {
@@ -117,7 +113,7 @@ function demoBlockPlugin(md: any) {
         return defaultRender(tokens, idx, options, env, ...args);
       }
 
-      const frontmatter = env.frontmatter
+      const frontmatter = env.frontmatter;
 
       const mdDir = dirname(frontmatter.realPath ?? path);
       const srcPath = resolve(mdDir, props.src);
@@ -127,13 +123,14 @@ function demoBlockPlugin(md: any) {
         title: props.title,
         desc: props.desc,
         path: srcPath,
+        enableIntersectionObserver: props.enableIntersectionObserver,
         code,
       });
     };
-  }
+  };
 
-  addRenderRule('html_block')
-  addRenderRule('html_inline')
+  addRenderRule('html_block');
+  addRenderRule('html_inline');
 }
 
 function getPropsMap(attrs: any) {
@@ -147,14 +144,14 @@ function getPropsMap(attrs: any) {
 
 export function parseProps(content: string) {
   const ast = baseParse(content);
-  const demoElement = ast.children[0];
+  const demoElement = ast.children[0] as any;
 
   return getPropsMap(demoElement.props as any[]);
 }
 
 function fencePlugin(md: any) {
   const defaultRender = md.renderer.rules.fence;
-  md.renderer.rules.fence = (tokens: any, idx: number, options, env, ...args: any[]) => {
+  md.renderer.rules.fence = (tokens: any, idx: number, options: any, env: any, ...args: any[]) => {
     const token = tokens[idx];
     if (token.info.trim() !== FenceDemoTag) {
       return defaultRender(tokens, idx, options, env, ...args);

docs/.vitepress/theme/custom.less

@@ -1,5 +1,6 @@
 :root {
   --vp-layout-max-width: 1920px;
+  --tp-base-background-color: hsla(0, 0%, 10%, 0.8);
   scroll-behavior: smooth;
 }
 

docs/.vitepress/theme/index.ts

@@ -1,4 +1,3 @@
-// @ts-nocheck
 // import { defineClientComponent } from 'vitepress';
 import DefaultTheme from 'vitepress/theme';
 import { SfcPlayground } from '@sakitam-gis/vitepress-playground';