refact(website): Changed folder structure for multi-language support in documentation

.npmignore

@@ -11,7 +11,7 @@ tsconfig.build.json
 .eslintrc.js
 eslint.config.mjs
 prettier.config.mjs
-vite.config.mts
+vite.config.ts
 biome.json
 
 # Git files

README.md

@@ -1,6 +1,6 @@
 <div align="center">
   <a href="https://repomix.com">
-    <img src="website/client/public/images/repomix-title.png" alt="Repomix" width="500" height="auto" />
+    <img src="website/client/src/public/images/repomix-title.png" alt="Repomix" width="500" height="auto" />
   </a>
   <p align="center">
     <b>Pack your codebase into AI-friendly formats</b>
@@ -83,11 +83,11 @@ This file contains all the files in the repository combined into one.
 I want to refactor the code, so please review it first.
 ```
 
-![Repomix File Usage 1](website/client/public/images/docs/repomix-file-usage-1.png)
+![Repomix File Usage 1](website/client/src/public/images/docs/repomix-file-usage-1.png)
 
 When you propose specific changes, the AI might be able to generate code accordingly. With features like Claude's Artifacts, you could potentially output multiple files, allowing for the generation of multiple interdependent pieces of code.
 
-![Repomix File Usage 2](website/client/public/images/docs/repomix-file-usage-2.png)
+![Repomix File Usage 2](website/client/src/public/images/docs/repomix-file-usage-2.png)
 
 Happy coding! 🚀
 

website/client/.vitepress/config.mts → website/client/.vitepress/config.ts

@@ -1,65 +1,38 @@
 import { defineConfig } from 'vitepress';
+import { configEn } from './config/configEn';
 
 const googleAnalyticsTag = 'G-7PTT4PLC69';
 
+/**
+ * Vitepress Configuration
+ *
+ * Reference
+ * see: https://github.com/vuejs/vitepress/tree/main/docs
+ */
 export default defineConfig({
   title: 'Repomix',
-  description: 'Pack your codebase into AI-friendly formats',
+
+  srcDir: 'src',
+
+  rewrites: {
+    // rewrite to `en` locale
+    'en/:rest*': ':rest*',
+  },
+
   lastUpdated: true,
+  cleanUrls: true,
   metaChunk: true,
+
   sitemap: {
     hostname: 'http://repomix.com/',
   },
+
+  // Shared configuration
   themeConfig: {
     logo: { src: '/images/repomix-logo.svg', width: 24, height: 24 },
     search: {
       provider: 'local',
     },
-    nav: [
-      // guide
-      { text: 'Guide', link: '/guide/' },
-      { text: 'Join Discord', link: 'https://discord.gg/wNYzTwZFku' },
-    ],
-    sidebar: {
-      '/guide/': [
-        {
-          text: 'Guide',
-          items: [
-            { text: 'Getting Started', link: '/guide/' },
-            { text: 'Installation', link: '/guide/installation' },
-            { text: 'Basic Usage', link: '/guide/usage' },
-            { text: 'Prompt Examples', link: '/guide/prompt-examples' },
-            { text: 'Output Formats', link: '/guide/output' },
-            { text: 'Command Line Options', link: '/guide/command-line-options' },
-            { text: 'Remote Repository Processing', link: '/guide/remote-repository-processing' },
-            { text: 'Configuration', link: '/guide/configuration' },
-            { text: 'Custom Instructions', link: '/guide/custom-instructions' },
-            { text: 'Comment Removal', link: '/guide/comment-removal' },
-            { text: 'Security', link: '/guide/security' },
-            {
-              text: 'Tips & Tricks',
-              items: [{ text: 'Best Practices', link: '/guide/tips/best-practices' }],
-            },
-            {
-              text: 'Development',
-              items: [
-                { text: 'Contributing', link: '/guide/development/' },
-                { text: 'Setup', link: '/guide/development/setup' },
-              ],
-            },
-          ],
-        },
-      ],
-      '/development/': [
-        {
-          text: 'Development',
-          items: [
-            { text: 'Contributing', link: '/development/' },
-            { text: 'Setup', link: '/development/setup' },
-          ],
-        },
-      ],
-    },
     socialLinks: [
       { icon: 'discord', link: 'https://discord.gg/wNYzTwZFku' },
       { icon: 'github', link: 'https://github.com/yamadashy/repomix' },
@@ -69,6 +42,16 @@ export default defineConfig({
       copyright: 'Copyright © 2024 Kazuki Yamada',
     },
   },
+
+  // i18n configuration
+  locales: {
+    root: {
+      label: 'English',
+      lang: 'en-US',
+      ...configEn,
+    },
+  },
+
   head: [
     // Favicon
     ['link', { rel: 'icon', href: '/images/repomix-logo.svg' }],

website/client/.vitepress/config/configEn.ts

@@ -0,0 +1,44 @@
+import { defineConfig } from 'vitepress';
+
+export const configEn = defineConfig({
+  lang: 'en-US',
+  description: 'Pack your codebase into AI-friendly formats',
+  themeConfig: {
+    nav: [
+      // guide
+      { text: 'Guide', link: '/guide/' },
+      { text: 'Join Discord', link: 'https://discord.gg/wNYzTwZFku' },
+    ],
+    sidebar: {
+      '/guide/': [
+        {
+          text: 'Guide',
+          items: [
+            { text: 'Getting Started', link: '/guide/' },
+            { text: 'Installation', link: '/guide/installation' },
+            { text: 'Basic Usage', link: '/guide/usage' },
+            { text: 'Prompt Examples', link: '/guide/prompt-examples' },
+            { text: 'Output Formats', link: '/guide/output' },
+            { text: 'Command Line Options', link: '/guide/command-line-options' },
+            { text: 'Remote Repository Processing', link: '/guide/remote-repository-processing' },
+            { text: 'Configuration', link: '/guide/configuration' },
+            { text: 'Custom Instructions', link: '/guide/custom-instructions' },
+            { text: 'Comment Removal', link: '/guide/comment-removal' },
+            { text: 'Security', link: '/guide/security' },
+            {
+              text: 'Tips & Tricks',
+              items: [{ text: 'Best Practices', link: '/guide/tips/best-practices' }],
+            },
+            {
+              text: 'Development',
+              items: [
+                { text: 'Contributing', link: '/guide/development/' },
+                { text: 'Setup', link: '/guide/development/setup' },
+              ],
+            },
+          ],
+        },
+      ],
+    },
+  },
+});

website/client/.vitepress/theme/index.ts

@@ -1,7 +1,7 @@
 import type { Theme } from 'vitepress';
 import DefaultTheme from 'vitepress/theme';
 import { h } from 'vue';
-import Home from './components/Home.vue';
+import Home from '../../components/Home.vue';
 import './custom.css';
 
 export default {

website/client/package.json

@@ -1,5 +1,6 @@
 {
   "private": true,
+  "type": "module",
   "scripts": {
     "docs:dev": "vitepress dev",
     "docs:build": "vitepress build",

website/client/guide/index.md → website/client/src/en/guide/index.md

@@ -39,10 +39,10 @@ Happy coding! 🚀
 
 ## What's Next?
 
-- [Installation Guide](./installation.md): Different ways to install Repomix
-- [Usage Guide](./usage.md): Learn about basic and advanced features
-- [Configuration](./configuration.md): Customize Repomix for your needs
-- [Security Features](./security.md): Learn about security checks
+- [Installation Guide](installation.md): Different ways to install Repomix
+- [Usage Guide](usage.md): Learn about basic and advanced features
+- [Configuration](configuration.md): Customize Repomix for your needs
+- [Security Features](security.md): Learn about security checks
 
 ## Community
 

website/client/tsconfig.node.json

@@ -6,5 +6,5 @@
     "moduleResolution": "bundler",
     "allowSyntheticDefaultImports": true
   },
-  "include": [".vitepress/config.mts"]
+  "include": [".vitepress/config.ts"]
 }