Merge branch 'main' into release/2.9.8

Author: ShenQingchuan

.github/workflows/deploy.yml

@@ -0,0 +1,39 @@
+name: Deploy to Gitee
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 6
+
+      - name: Set node version to 16.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          registry-url: https://registry.npmjs.org/
+          cache: "pnpm"
+
+      - name: Install deps
+        run: pnpm install
+
+      - run: pnpm run build
+      - run: |
+          cd .vitepress/dist
+          git init
+          git config user.email "[email protected]"
+          git config user.name "Evan You"
+          git add .
+          git commit -m "update docs"
+          git remote add origin https://yyx990803:${{ secrets.GITEE_TOKEN }}@gitee.com/vuejs-cn/vite-docs-cn.git
+          git push origin HEAD:master --force

.gitignore

@@ -0,0 +1,10 @@
+.DS_Store
+Thumbs.db
+db.json
+*.log
+node_modules/
+.deploy*/
+package-lock.json
+yarn.lock
+.vitepress/dist
+*.local

.vitepress/config.js

@@ -1,42 +1,42 @@
 // @ts-check
 
+const pkg = require('../package.json')
+
 /**
  * @type {import('vitepress').UserConfig}
  */
 module.exports = {
-  title: 'Vite',
-  description: 'Next Generation Frontend Tooling',
-  head: [['link', { rel: 'icon', type: 'image/svg+xml', href: '/logo.svg' }]],
+  title: 'Vite 官方中文文档',
+  lang: 'zh-CN',
+  description: '下一代前端开发与构建工具',
+  head: [
+    ['link', { rel: 'icon', type: 'image/svg+xml', href: '/logo.svg' }],
+    ['script', { src: 'https://cdn.wwads.cn/js/makemoney.js', async: '' }]
+  ],
   vue: {
     reactivityTransform: true
   },
   themeConfig: {
-    repo: 'vitejs/vite',
+    repo: pkg.repository,
     logo: '/logo.svg',
-    docsDir: 'docs',
     docsBranch: 'main',
     editLinks: true,
-    editLinkText: 'Suggest changes to this page',
+    editLinkText: '为此页提供修改建议',
 
     algolia: {
       apiKey: 'b573aa848fd57fb47d693b531297403c',
       indexName: 'vitejs',
       searchParameters: {
-        facetFilters: ['tags:en']
+        facetFilters: ['tags:cn']
       }
     },
 
-    carbonAds: {
-      carbon: 'CEBIEK3N',
-      placement: 'vitejsdev'
-    },
-
     nav: [
-      { text: 'Guide', link: '/guide/' },
-      { text: 'Config', link: '/config/' },
-      { text: 'Plugins', link: '/plugins/' },
+      { text: '指引', link: '/guide/' },
+      { text: '配置', link: '/config/' },
+      { text: '插件', link: '/plugins/' },
       {
-        text: 'Links',
+        text: '相关链接',
         items: [
           {
             text: 'Twitter',
@@ -51,21 +51,21 @@ module.exports = {
             link: 'https://github.com/vitejs/awesome-vite'
           },
           {
-            text: 'DEV Community',
+            text: 'Dev.to 社区',
             link: 'https://dev.to/t/vite'
           },
           {
-            text: 'Rollup Plugins Compat',
+            text: 'Rollup 插件兼容',
             link: 'https://vite-rollup-plugins.patak.dev/'
           },
           {
-            text: 'Changelog',
+            text: '更新日志',
             link: 'https://github.com/vitejs/vite/blob/main/packages/vite/CHANGELOG.md'
           }
         ]
       },
       {
-        text: 'Languages',
+        text: '多语言',
         items: [
           {
             text: 'English',
@@ -89,67 +89,67 @@ module.exports = {
       // catch-all fallback
       '/': [
         {
-          text: 'Guide',
+          text: '指引',
           children: [
             {
-              text: 'Why Vite',
+              text: '为什么选 Vite',
               link: '/guide/why'
             },
             {
-              text: 'Getting Started',
+              text: '开始',
               link: '/guide/'
             },
             {
-              text: 'Features',
+              text: '功能',
               link: '/guide/features'
             },
             {
-              text: 'Using Plugins',
+              text: '使用插件',
               link: '/guide/using-plugins'
             },
             {
-              text: 'Dependency Pre-Bundling',
+              text: '依赖预构建',
               link: '/guide/dep-pre-bundling'
             },
             {
-              text: 'Static Asset Handling',
+              text: '静态资源处理',
               link: '/guide/assets'
             },
             {
-              text: 'Building for Production',
+              text: '构建生产版本',
               link: '/guide/build'
             },
             {
-              text: 'Deploying a Static Site',
+              text: '部署静态站点',
               link: '/guide/static-deploy'
             },
             {
-              text: 'Env Variables and Modes',
+              text: '环境变量与模式',
               link: '/guide/env-and-mode'
             },
             {
-              text: 'Server-Side Rendering (SSR)',
+              text: '服务端渲染（SSR）',
               link: '/guide/ssr'
             },
             {
-              text: 'Backend Integration',
+              text: '后端集成',
               link: '/guide/backend-integration'
             },
             {
-              text: 'Comparisons',
+              text: '比较',
               link: '/guide/comparisons'
             },
             {
-              text: 'Migration from v1',
+              text: '从 v1 迁移',
               link: '/guide/migration'
             }
           ]
         },
         {
-          text: 'APIs',
+          text: 'API',
           children: [
             {
-              text: 'Plugin API',
+              text: '插件 API',
               link: '/guide/api-plugin'
             },
             {
@@ -161,12 +161,21 @@ module.exports = {
               link: '/guide/api-javascript'
             },
             {
-              text: 'Config Reference',
+              text: '配置参考',
               link: '/config/'
             }
           ]
         }
       ]
     }
+  },
+
+  markdown: {
+    anchor: {
+      renderPermalink: require('./render-perma-link')
+    },
+    config: (md) => {
+      md.use(require('./markdown-it-custom-anchor'))
+    }
   }
 }

.vitepress/markdown-it-custom-anchor/index.js

@@ -0,0 +1,25 @@
+const anchorMatch = /^.+(\s*\{#([a-z0-9\-_]+?)\}\s*)$/;
+
+const removeAnchorFromTitle = (oldTitle) => {
+  const match = anchorMatch.exec(oldTitle);
+  return match ? oldTitle.replace(match[1], '').trim() : oldTitle;
+}
+
+module.exports = function plugin(md) {
+  const oldTitle = md.renderer.rules.text;
+  md.renderer.rules.text = (tokens, idx, options, env, slf) => {
+    const titleAndId = oldTitle(tokens, idx, options, env, slf);
+    return removeAnchorFromTitle(titleAndId);
+  };
+
+  const oldHeading = md.renderer.rules.heading_open;
+  md.renderer.rules.heading_open = (tokens, idx, options, env, slf) => {
+    const head = oldHeading(tokens, idx, options, env, slf);
+    const data = md.__data;
+    const headers = data.headers || (data.headers = []);
+    headers.forEach(element => {
+      element.title = removeAnchorFromTitle(element.title);
+    });
+    return head;
+  }
+};

.vitepress/render-perma-link/index.js

@@ -0,0 +1,37 @@
+const position = {
+  false: 'push',
+  true: 'unshift'
+}
+
+const renderPermalink = (slug, opts, state, permalink) => {
+  try {
+    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: ' ' })
+
+    const linkTokens = [
+      Object.assign(new state.Token('link_open', 'a', 1), {
+        attrs: [
+          ...(opts.permalinkClass ? [['class', opts.permalinkClass]] : []),
+          ['href', opts.permalinkHref(slug, state)],
+          ...Object.entries(opts.permalinkAttrs(slug, state))
+        ]
+      }),
+      Object.assign(new state.Token('html_block', '', 0), { content: opts.permalinkSymbol }),
+      new state.Token('link_close', 'a', -1)
+    ]
+    if (opts.permalinkSpace) {
+      linkTokens[position[!opts.permalinkBefore]](space())
+    }
+    state.tokens[permalink + 1].children[position[opts.permalinkBefore]](...linkTokens)
+  } catch(e) {}
+}
+
+module.exports = renderPermalink

.vitepress/rewrite-title/index.js

@@ -0,0 +1,44 @@
+const path = require('path')
+const fsp = require('fs').promises
+const matterService = require('../utils/frontmatter-service')
+const workspacePath = path.resolve(__dirname, '..', '..')
+
+const h1MdRegExp = /^#\s+(.+)\s+(\{#([\w-]+)\})$/
+/** 在此书写所有文章所在的目录名 */
+const articleDirs = ['blog', 'config', 'guide', 'plugins']
+
+const rewriteMarkdownTitle = (filePath) => {
+  const matter = matterService.open(filePath)
+  const lines = String(matter.file).split(/\r?\n/)
+  const h1Line = lines.find((line) => h1MdRegExp.test(line))
+  if (!h1Line) return
+
+  const title = h1MdRegExp.exec(h1Line)[1]
+  matter.set('title', title).save()
+}
+
+const ergodicDirectory = async (dirPath) => {
+  try {
+    const files = await fsp.readdir(dirPath)
+    for (let i = 0; i < files.length; i++) {
+      const file = files[i],
+        filePath = path.join(dirPath, file)
+      const stats = await fsp.stat(filePath)
+      if (stats.isFile()) {
+        if (filePath.split('.').pop().toLowerCase() === 'md') {
+          rewriteMarkdownTitle(filePath)
+        }
+      } else if (stats.isDirectory()) {
+        if (articleDirs.includes(filePath.split('/').pop())) {
+          await ergodicDirectory(filePath)
+        }
+      }
+    }
+  } catch (err) {
+    console.warn(
+      `vite-docs-cn: failed to rewrite frontmatter for titles.\n ${err}!`
+    )
+  }
+}
+
+module.exports = () => ergodicDirectory(workspacePath)