feat: add english document

Author: Zxilly

.vitepress/config.mts

@@ -1,9 +1,8 @@
 import { defineConfig } from 'vitepress'
 import type { DefaultTheme } from 'vitepress'
-import llmstxt from 'vitepress-plugin-llms'
 import cangjie from './cangjie.tmLanguage.json'
 
-const GUIDES: DefaultTheme.NavItemWithLink[] = [
+const zhGuides: DefaultTheme.NavItemWithLink[] = [
   { text: '简介', link: '/guide/' },
   { text: '快速开始', link: '/guide/quick_start' },
   { text: '安装', link: '/guide/install' },
@@ -12,10 +11,117 @@ const GUIDES: DefaultTheme.NavItemWithLink[] = [
   { text: 'LLM', link: '/guide/llm' },
 ]
 
+const enGuides: DefaultTheme.NavItemWithLink[] = [
+  { text: 'Introduction', link: '/en/guide/' },
+  { text: 'Quick Start', link: '/en/guide/quick_start' },
+  { text: 'Installation', link: '/en/guide/install' },
+  { text: 'Command Line', link: '/en/guide/command_line' },
+  { text: 'Limitations', link: '/en/guide/limitation' },
+  { text: 'LLM', link: '/en/guide/llm' },
+]
+
 export default defineConfig({
   title: "cjbind",
-  lang: "zh-CN",
   description: "自动生成仓颉到 C 库的 FFI 绑定代码",
+
+  locales: {
+    root: {
+      label: '简体中文',
+      lang: 'zh-CN',
+      themeConfig: {
+        nav: [
+          {
+            text: '指南',
+            items: [{ items: zhGuides }],
+          },
+        ],
+        sidebar: {
+          '/': [
+            {
+              text: '指南',
+              items: zhGuides,
+            },
+          ],
+        },
+        editLink: {
+          pattern: 'https://github.com/cjbind/cjbind-docs/edit/master/:path',
+          text: '在 GitHub 上编辑本页',
+        },
+        footer: {
+          message: '以 MIT 许可证发布',
+          copyright: `版权所有 © 2024 - ${new Date().getFullYear()} Zxilly`,
+        },
+        docFooter: {
+          prev: '上一页',
+          next: '下一页',
+        },
+        outline: {
+          label: '目录',
+          level: 'deep'
+        },
+        langMenuLabel: '多语言',
+        returnToTopLabel: '回到顶部',
+        sidebarMenuLabel: '菜单',
+        darkModeSwitchLabel: '主题',
+        lightModeSwitchTitle: '切换到浅色模式',
+        darkModeSwitchTitle: '切换到深色模式',
+        lastUpdated: {
+          text: '上次更新于',
+          formatOptions: {
+            dateStyle: 'short',
+            timeStyle: 'short',
+            hour12: false,
+            timeZone: 'Asia/Shanghai'
+          }
+        }
+      }
+    },
+    en: {
+      label: 'English',
+      lang: 'en-US',
+      link: '/en/',
+      themeConfig: {
+        nav: [
+          {
+            text: 'Guide',
+            items: [{ items: enGuides }],
+          },
+        ],
+        sidebar: {
+          '/en/': [
+            {
+              text: 'Guide',
+              items: enGuides,
+            },
+          ],
+        },
+        editLink: {
+          pattern: 'https://github.com/cjbind/cjbind-docs/edit/master/:path',
+          text: 'Edit this page on GitHub',
+        },
+        footer: {
+          message: 'Released under the MIT License',
+          copyright: `Copyright © 2024 - ${new Date().getFullYear()} Zxilly`,
+        },
+        docFooter: {
+          prev: 'Previous',
+          next: 'Next',
+        },
+        outline: {
+          label: 'Table of Contents',
+          level: 'deep'
+        },
+        lastUpdated: {
+          text: 'Last updated',
+          formatOptions: {
+            dateStyle: 'short',
+            timeStyle: 'short',
+          }
+        }
+      }
+    }
+  },
+
   markdown: {
     theme: {
       light: 'vitesse-light',
@@ -30,96 +136,57 @@ export default defineConfig({
       dangerLabel: '危险',
       infoLabel: '信息',
       detailsLabel: '详细信息'
-    }
-  },
-  vite: {
-    plugins: [llmstxt({
-      domain: 'https://cjbind.zxilly.dev',
-      description: 'cjbind 是一个自动生成仓颉到 C 库的 FFI 绑定代码的工具',
-    })]
+    },
   },
+
   themeConfig: {
     siteTitle: 'cjbind',
-    nav: [
-      {
-        text: '指南',
-        items: [
-          {
-            items: GUIDES,
-          },
-        ],
-      },
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/cjbind/cjbind' },
     ],
-
-    sidebar: {
-      '/': [
-        {
-          text: '指南',
-          items: GUIDES,
-        },
-      ],
-    },
-
-    editLink: {
-      pattern: 'https://github.com/cjbind/cjbind-docs/edit/master/:path',
-      text: '在 GitHub 上编辑本页',
-    },
     search: {
       provider: 'local',
       options: {
-        translations: {
-          button: {
-            buttonText: '搜索文档',
-            buttonAriaLabel: '搜索文档',
+        locales: {
+          root: {
+            translations: {
+              button: {
+                buttonText: '搜索文档',
+                buttonAriaLabel: '搜索文档',
+              },
+              modal: {
+                noResultsText: '无法找到相关结果',
+                resetButtonTitle: '清除查询条件',
+                footer: {
+                  selectText: '选择',
+                  navigateText: '切换',
+                  closeText: '关闭',
+                },
+              },
+            },
           },
-          modal: {
-            noResultsText: '无法找到相关结果',
-            resetButtonTitle: '清除查询条件',
-            footer: {
-              selectText: '选择',
-              navigateText: '切换',
-              closeText: '关闭',
+          en: {
+            translations: {
+              button: {
+                buttonText: 'Search',
+                buttonAriaLabel: 'Search',
+              },
+              modal: {
+                noResultsText: 'No results found',
+                resetButtonTitle: 'Reset search',
+                footer: {
+                  selectText: 'Select',
+                  navigateText: 'Navigate',
+                  closeText: 'Close',
+                },
+              },
             },
           },
         },
       },
     },
-
-    socialLinks: [
-      { icon: 'github', link: 'https://github.com/cjbind/cjbind' },
-    ],
-
-    footer: {
-      message: '以 MIT 许可证发布',
-      copyright: `版权所有 © 2024 - ${new Date().getFullYear()} Zxilly`,
-    },
-
-    docFooter: {
-      prev: '上一页',
-      next: '下一页',
-    },
-
-    outline: {
-      label: '目录',
-      level: 'deep'
-    },
-
-    langMenuLabel: '多语言',
-    returnToTopLabel: '回到顶部',
-    sidebarMenuLabel: '菜单',
-    darkModeSwitchLabel: '主题',
-    lightModeSwitchTitle: '切换到浅色模式',
-    darkModeSwitchTitle: '切换到深色模式',
-    lastUpdated: {
-      text: '上次更新于',
-      formatOptions: {
-        dateStyle: 'short',
-        timeStyle: 'short',
-        hour12: false,
-        timeZone: 'Asia/Shanghai'
-      }
-    }
   },
+
   head: [
     [
       'script',

.vitepress/theme/index.ts

@@ -0,0 +1,36 @@
+import DefaultTheme from 'vitepress/theme'
+import type { EnhanceAppContext } from 'vitepress'
+import { onMounted } from 'vue'
+
+function handleLocaleRedirect(router: EnhanceAppContext['router']) {
+  const hasVisited = localStorage.getItem('locale-redirect')
+  if (hasVisited) return
+
+  const currentPath = window.location.pathname
+
+  if (currentPath.startsWith('/en/')) {
+    localStorage.setItem('locale-redirect', 'true')
+    return
+  }
+
+  const browserLang = navigator.language || navigator.languages?.[0]
+
+  if (!browserLang || !browserLang.toLowerCase().startsWith('zh')) {
+    localStorage.setItem('locale-redirect', 'true')
+    const newPath = currentPath === '/' ? '/en/' : `/en${currentPath}`
+    router.go(newPath)
+  } else {
+    localStorage.setItem('locale-redirect', 'true')
+  }
+}
+
+export default {
+  extends: DefaultTheme,
+  enhanceApp({ router }: EnhanceAppContext) {
+    if (typeof window === 'undefined') return
+
+    onMounted(() => {
+      handleLocaleRedirect(router)
+    })
+  }
+}

en/guide/command_line.md

@@ -0,0 +1,40 @@
+# Command Line Usage
+
+If you have installed `cjbind` according to the instructions in [Installation](/en/guide/install) and can view the version number using the `cjbind --version` command, you can use the `cjbind` command to generate FFI binding code.
+
+The `cjbind` command takes a C header file path as input and optionally specifies an output file path for the generated bindings. If no output file path is provided, the binding code will be output to `stdout`.
+
+If we want to generate Cangjie FFI bindings from a C header file named `library.h` and place them in a `cjbind_ffi.cj` file, we can invoke `cjbind` like this:
+
+```bash
+$ cjbind -o cjbind_ffi.cj library.h
+```
+
+To view more detailed help information, pass the `--help` argument:
+
+```text
+$ cjbind --help
+Automatically generate FFI bindings from C libraries to Cangjie.
+
+Usage: cjbind <OPTIONS> <HEADER> -- <CLANG_ARGS>
+
+Arguments:
+    <HEADER>          C header file path
+    [CLANG_ARGS]...   Arguments that will be passed directly to clang
+
+Options:
+        --no-enum-prefix                 When generating enums, do not use enum names as prefixes for enum values
+        --no-detect-include-path         Disable automatic include path detection
+        --no-comment                     Do not attempt to generate comments in the code
+        --no-layout-test                 Do not generate layout test code
+        --builtins                       Generate bindings for builtin definitions like __builtin_va_list
+        --make-func-wrapper              Generate foreign function wrappers to allow calls from outside the package
+        --func-wrapper-suffix <SUFFIX>   Suffix used when generating function wrappers, defaults to _cjbindwrapper
+        --auto-cstring                   Convert char* to CString instead of CPointer<UInt8>
+        --array-pointers-in-args         Convert arrays T arr[size] to VArray<T, $size> instead of CPointer<T>
+        --make-cjstring                  Convert C strings to Cangjie String instead of VArray<UInt8>, which may cause binary representation inconsistency
+    -o, --output <FILE>                  Output the generated bindings to a file
+    -p, --package <PACKAGE>              Package name in the generated bindings
+    -v, --version                        Display version number and exit
+    -h, --help                           Display help information
+```