diff options
| -rw-r--r-- | packages/docs/README.md | 71 | ||||
| -rw-r--r-- | packages/docs/content/docs/zh/features/meta.json | 2 | ||||
| -rw-r--r-- | packages/docs/content/docs/zh/meta.json | 4 |
3 files changed, 64 insertions, 13 deletions
diff --git a/packages/docs/README.md b/packages/docs/README.md index 055e479..63b9290 100644 --- a/packages/docs/README.md +++ b/packages/docs/README.md @@ -11,6 +11,12 @@ The documentation covers: - **Development**: Building and contributing to DropOut - **Troubleshooting**: Common issues and solutions +### Multi-language Support + +The documentation is available in: +- **English** (default) - `content/docs/en/` +- **简体中文** (Simplified Chinese) - `content/docs/zh/` + ## Development ### Prerequisites @@ -34,6 +40,8 @@ pnpm dev This starts the development server at `http://localhost:5173` with hot reload enabled. +The documentation automatically supports language switching between English and Chinese. + ### Build for Production ```bash @@ -64,18 +72,50 @@ pnpm format packages/docs/ ├── content/ │ └── docs/ # Documentation content (MDX) -│ ├── index.mdx # Home page -│ ├── getting-started.mdx -│ ├── architecture.mdx -│ ├── development.mdx -│ ├── troubleshooting.mdx -│ └── features/ # Feature-specific docs +│ ├── en/ # English documentation +│ │ ├── index.mdx +│ │ ├── getting-started.mdx +│ │ ├── architecture.mdx +│ │ ├── development.mdx +│ │ ├── troubleshooting.mdx +│ │ └── features/ +│ └── zh/ # Chinese documentation +│ ├── index.mdx +│ ├── getting-started.mdx +│ ├── architecture.mdx +│ ├── development.mdx +│ ├── troubleshooting.mdx +│ └── features/ ├── app/ # React Router app ├── public/ # Static assets -├── source.config.ts # Fumadocs configuration +├── source.config.ts # Fumadocs configuration (i18n enabled) └── react-router.config.ts # React Router configuration ``` +## Internationalization (i18n) + +### Structure + +Documentation is organized by locale: +- English: `content/docs/en/` +- Chinese: `content/docs/zh/` + +Each locale has the same structure with translated content. + +### Configuration + +i18n is configured in: +- `source.config.ts`: Enables i18n support +- `app/lib/source.ts`: Defines available languages and default + +### Adding a New Language + +1. Create a new directory: `content/docs/{locale}/` +2. Copy the structure from `en/` or `zh/` +3. Translate all `.mdx` files +4. Update `meta.json` files with translated titles +5. Add the language to `app/lib/source.ts` + ## Writing Documentation ### MDX Format @@ -110,11 +150,22 @@ Fumadocs provides several components: ### Adding New Pages -1. Create new `.mdx` file in `content/docs/` +1. Create new `.mdx` file in `content/docs/{locale}/` 2. Add frontmatter with title and description 3. Write content using MDX 4. Update `meta.json` to include the page -5. Test locally with `pnpm dev` +5. Repeat for all supported languages +6. Test locally with `pnpm dev` + +### Translation Guidelines + +When translating content: +- Keep all code blocks in English +- Translate frontmatter (title, description) +- Keep technical terms (Tauri, Rust, Svelte, etc.) in English +- Translate UI elements and descriptions +- Keep all links and URLs unchanged +- Maintain the same structure and formatting ### Organizing Content @@ -142,7 +193,7 @@ The documentation is automatically deployed when changes are merged to the main 1. Fork the repository 2. Create a feature branch -3. Make your changes +3. Make your changes (in all supported languages) 4. Test locally 5. Submit a pull request diff --git a/packages/docs/content/docs/zh/features/meta.json b/packages/docs/content/docs/zh/features/meta.json index 4725321..2fb2ded 100644 --- a/packages/docs/content/docs/zh/features/meta.json +++ b/packages/docs/content/docs/zh/features/meta.json @@ -1,5 +1,5 @@ { - "title": "Features", + "title": "功能特性", "pages": [ "index", "authentication", diff --git a/packages/docs/content/docs/zh/meta.json b/packages/docs/content/docs/zh/meta.json index 8ad7ea2..527801e 100644 --- a/packages/docs/content/docs/zh/meta.json +++ b/packages/docs/content/docs/zh/meta.json @@ -1,11 +1,11 @@ { - "title": "Documentation", + "title": "文档", "pages": [ "index", "getting-started", "architecture", { - "title": "Features", + "title": "功能特性", "pages": [ "features/index", "features/authentication", |