feat: i18n link (#2137)

Author: sunchanglong

CONTRIBUTING.md

@@ -214,7 +214,7 @@ For an example, please refer to the [gRPC-SDK dictionary](docs/user-guide/ingest
 ## Build and preview the docs locally
 
 We highly encourage you to preview your changes locally before submitting a pull request.
-This project requires Node.js version 18.0.0 or higher.
+This project requires Node.js version 20.x or higher.
 Use `npm install -g pnpm` to install package manager, and start a local server with the following commands:
 
 ```shell
@@ -230,7 +230,7 @@ To preview the documentation in a specific language, use command `pnpm run start
 For example:
 
 ```cmd
-pnpm run start --locale zh
+DOC_LANG=zh pnpm start
 ```
 
 ## PR title check

docusaurus.config.ts

@@ -160,8 +160,15 @@ const config: Config = {
           sidebarPath: './sidebars.ts',
           // Please change this to your repo.
           // Remove this to remove the "edit this page" links.
-          editUrl:
-            'https://github.com/GreptimeTeam/docs/blob/main',
+          editUrl: ({ locale, version, versionDocsDirPath, docPath }) => {
+            if (locale === 'zh') {
+              // Chinese locale: i18n folder, versioned by current|version-<x>
+              const versionDir = version === 'current' ? 'current' : `version-${version}`;
+              return `https://github.com/GreptimeTeam/docs/edit/main/i18n/zh/docusaurus-plugin-content-docs/${versionDir}/${docPath}`;
+            }
+            // English locale: use Docusaurus-provided versionDocsDirPath
+            return `https://github.com/GreptimeTeam/docs/edit/main/${versionDocsDirPath}/${docPath}`;
+          },
           routeBasePath: '/',
           exclude: [
             'db-cloud-shared/**',
@@ -231,6 +238,21 @@ const config: Config = {
   trailingSlash: true,
   plugins: [
     ['docusaurus-biel', bielMetaMap[locale]],
+    function injectLocaleSwitchScript() {
+      return {
+        name: 'inject-locale-switch-script',
+        injectHtmlTags() {
+          return {
+            headTags: [
+              {
+                tagName: 'script',
+                attributes: { src: '/js/locale-switch.js' }
+              }
+            ]
+          };
+        }
+      };
+    }
   ],
 
   themeConfig: {
@@ -266,7 +288,7 @@ const config: Config = {
             {
               label: locale === 'en' ? '中文' : 'English',
               to: locale === 'en' ? 'https://docs.greptime.cn' : 'https://docs.greptime.com',
-              className: 'dropdown__link',
+              className: 'dropdown__link locale-switch-link',
             },
           ],
         },

package.json

@@ -5,6 +5,7 @@
   "scripts": {
     "docusaurus": "docusaurus",
     "start": "docusaurus start",
+    "start:zh": "DOC_LANG=zh pnpm start",
     "build": "docusaurus build",
     "swizzle": "docusaurus swizzle",
     "deploy": "docusaurus deploy",

static/js/locale-switch.js

@@ -0,0 +1,42 @@
+(function() {
+  if (typeof window === 'undefined') return;
+
+  function updateLocaleSwitchHref() {
+    var link = document.querySelector('.locale-switch-link');
+    if (!link) return;
+    try {
+      var current = new URL(window.location.href);
+      var target = new URL(link.href);
+      link.href = current.protocol + '//' + target.host + current.pathname + current.search + current.hash;
+    } catch (e) {
+      // ignore
+    }
+  }
+
+
+  // Intercept clicks on the locale switch link to rewrite URL immediately
+  function handleLocaleSwitchClick(event) {
+    var link = event.target.closest('.locale-switch-link');
+    if (!link) return;
+    
+    try {
+      updateLocaleSwitchHref();
+    } catch (e) {}
+  }
+
+  // Set up click listener on document to catch all clicks
+  document.addEventListener('click', handleLocaleSwitchClick, true);
+  
+  // Initial update on load
+  setTimeout(updateLocaleSwitchHref, 1000);
+
+  if ('navigation' in window && window.navigation) {
+    // Update when URL changes due to SPA navigation
+    window.navigation.addEventListener('navigate', function () {
+      // run after route has settled
+      setTimeout(updateLocaleSwitchHref, 0);
+    });
+  }
+  
+  
+})();