diff --git a/.npmignore b/.npmignore index 92cf70ec0..b56538923 100644 --- a/.npmignore +++ b/.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 diff --git a/README.md b/README.md index d1f277e2d..32b14dae5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
+
Pack your codebase into AI-friendly formats @@ -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. ``` - + 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. - + Happy coding! 🚀 diff --git a/website/client/.vitepress/config.mts b/website/client/.vitepress/config.ts similarity index 57% rename from website/client/.vitepress/config.mts rename to website/client/.vitepress/config.ts index f21cdb4b4..300f18b81 100644 --- a/website/client/.vitepress/config.mts +++ b/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' }], diff --git a/website/client/.vitepress/config/configEn.ts b/website/client/.vitepress/config/configEn.ts new file mode 100644 index 000000000..614ae7af3 --- /dev/null +++ b/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' }, + ], + }, + ], + }, + ], + }, + }, +}); diff --git a/website/client/.vitepress/theme/index.ts b/website/client/.vitepress/theme/index.ts index 24114d19b..bb6d62043 100644 --- a/website/client/.vitepress/theme/index.ts +++ b/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 { diff --git a/website/client/.vitepress/theme/components/Hero.vue b/website/client/components/Hero.vue similarity index 100% rename from website/client/.vitepress/theme/components/Hero.vue rename to website/client/components/Hero.vue diff --git a/website/client/.vitepress/theme/components/Home.vue b/website/client/components/Home.vue similarity index 100% rename from website/client/.vitepress/theme/components/Home.vue rename to website/client/components/Home.vue diff --git a/website/client/.vitepress/theme/components/ResultViewer.vue b/website/client/components/ResultViewer.vue similarity index 100% rename from website/client/.vitepress/theme/components/ResultViewer.vue rename to website/client/components/ResultViewer.vue diff --git a/website/client/.vitepress/theme/components/TryIt.vue b/website/client/components/TryIt.vue similarity index 100% rename from website/client/.vitepress/theme/components/TryIt.vue rename to website/client/components/TryIt.vue diff --git a/website/client/.vitepress/theme/components/api/client.ts b/website/client/components/api/client.ts similarity index 100% rename from website/client/.vitepress/theme/components/api/client.ts rename to website/client/components/api/client.ts diff --git a/website/client/.vitepress/theme/components/utils/analytics.ts b/website/client/components/utils/analytics.ts similarity index 100% rename from website/client/.vitepress/theme/components/utils/analytics.ts rename to website/client/components/utils/analytics.ts diff --git a/website/client/package-lock.json b/website/client/package-lock.json index 7db5730b0..e9f4dfa3a 100644 --- a/website/client/package-lock.json +++ b/website/client/package-lock.json @@ -1,5 +1,5 @@ { - "name": "client", + "name": "app", "lockfileVersion": 3, "requires": true, "packages": { diff --git a/website/client/package.json b/website/client/package.json index 1a00b84cf..b79b55f6d 100644 --- a/website/client/package.json +++ b/website/client/package.json @@ -1,5 +1,6 @@ { "private": true, + "type": "module", "scripts": { "docs:dev": "vitepress dev", "docs:build": "vitepress build", diff --git a/website/client/guide/command-line-options.md b/website/client/src/en/guide/command-line-options.md similarity index 100% rename from website/client/guide/command-line-options.md rename to website/client/src/en/guide/command-line-options.md diff --git a/website/client/guide/comment-removal.md b/website/client/src/en/guide/comment-removal.md similarity index 100% rename from website/client/guide/comment-removal.md rename to website/client/src/en/guide/comment-removal.md diff --git a/website/client/guide/configuration.md b/website/client/src/en/guide/configuration.md similarity index 100% rename from website/client/guide/configuration.md rename to website/client/src/en/guide/configuration.md diff --git a/website/client/guide/custom-instructions.md b/website/client/src/en/guide/custom-instructions.md similarity index 100% rename from website/client/guide/custom-instructions.md rename to website/client/src/en/guide/custom-instructions.md diff --git a/website/client/guide/development/index.md b/website/client/src/en/guide/development/index.md similarity index 100% rename from website/client/guide/development/index.md rename to website/client/src/en/guide/development/index.md diff --git a/website/client/guide/development/setup.md b/website/client/src/en/guide/development/setup.md similarity index 100% rename from website/client/guide/development/setup.md rename to website/client/src/en/guide/development/setup.md diff --git a/website/client/guide/index.md b/website/client/src/en/guide/index.md similarity index 85% rename from website/client/guide/index.md rename to website/client/src/en/guide/index.md index aa9a04385..0de96685b 100644 --- a/website/client/guide/index.md +++ b/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 diff --git a/website/client/guide/installation.md b/website/client/src/en/guide/installation.md similarity index 100% rename from website/client/guide/installation.md rename to website/client/src/en/guide/installation.md diff --git a/website/client/guide/output.md b/website/client/src/en/guide/output.md similarity index 100% rename from website/client/guide/output.md rename to website/client/src/en/guide/output.md diff --git a/website/client/guide/prompt-examples.md b/website/client/src/en/guide/prompt-examples.md similarity index 100% rename from website/client/guide/prompt-examples.md rename to website/client/src/en/guide/prompt-examples.md diff --git a/website/client/guide/remote-repository-processing.md b/website/client/src/en/guide/remote-repository-processing.md similarity index 100% rename from website/client/guide/remote-repository-processing.md rename to website/client/src/en/guide/remote-repository-processing.md diff --git a/website/client/guide/security.md b/website/client/src/en/guide/security.md similarity index 100% rename from website/client/guide/security.md rename to website/client/src/en/guide/security.md diff --git a/website/client/guide/tips/best-practices.md b/website/client/src/en/guide/tips/best-practices.md similarity index 100% rename from website/client/guide/tips/best-practices.md rename to website/client/src/en/guide/tips/best-practices.md diff --git a/website/client/guide/usage.md b/website/client/src/en/guide/usage.md similarity index 100% rename from website/client/guide/usage.md rename to website/client/src/en/guide/usage.md diff --git a/website/client/index.md b/website/client/src/en/index.md similarity index 100% rename from website/client/index.md rename to website/client/src/en/index.md diff --git a/website/client/public/images/docs/repomix-file-usage-1.png b/website/client/src/public/images/docs/repomix-file-usage-1.png similarity index 100% rename from website/client/public/images/docs/repomix-file-usage-1.png rename to website/client/src/public/images/docs/repomix-file-usage-1.png diff --git a/website/client/public/images/docs/repomix-file-usage-2.png b/website/client/src/public/images/docs/repomix-file-usage-2.png similarity index 100% rename from website/client/public/images/docs/repomix-file-usage-2.png rename to website/client/src/public/images/docs/repomix-file-usage-2.png diff --git a/website/client/public/images/og-image-large.png b/website/client/src/public/images/og-image-large.png similarity index 100% rename from website/client/public/images/og-image-large.png rename to website/client/src/public/images/og-image-large.png diff --git a/website/client/public/images/repomix-logo.svg b/website/client/src/public/images/repomix-logo.svg similarity index 100% rename from website/client/public/images/repomix-logo.svg rename to website/client/src/public/images/repomix-logo.svg diff --git a/website/client/public/images/repomix-title.png b/website/client/src/public/images/repomix-title.png similarity index 100% rename from website/client/public/images/repomix-title.png rename to website/client/src/public/images/repomix-title.png diff --git a/website/client/tsconfig.node.json b/website/client/tsconfig.node.json index 69900490d..6e3a2242f 100644 --- a/website/client/tsconfig.node.json +++ b/website/client/tsconfig.node.json @@ -6,5 +6,5 @@ "moduleResolution": "bundler", "allowSyntheticDefaultImports": true }, - "include": [".vitepress/config.mts"] + "include": [".vitepress/config.ts"] } diff --git a/website/server/package-lock.json b/website/server/package-lock.json index 0e8941c59..6dd586e9f 100644 --- a/website/server/package-lock.json +++ b/website/server/package-lock.json @@ -1,5 +1,5 @@ { - "name": "server", + "name": "app", "lockfileVersion": 3, "requires": true, "packages": {