Skip to content

Commit f02913e

Browse files
authored
Merge pull request #3 from objectstack-ai/copilot/build-multi-language-documentation
2 parents fe8488e + 770fc07 commit f02913e

5 files changed

Lines changed: 731 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 61 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,67 @@
11
# docs
22

3+
A multi-language documentation site built with Fumadocs, supporting English and Chinese.
4+
5+
## Features
6+
7+
- 🌍 **Multi-language Support**: Full internationalization with English (en) and Chinese (zh-CN)
8+
- 📝 **MDX Content**: Write documentation using MDX for interactive content
9+
- 🔍 **Fast Search**: Quick search across all documentation
10+
- 🎨 **Modern UI**: Beautiful and responsive design with Fumadocs UI
11+
- 📱 **Mobile Friendly**: Fully responsive on all devices
12+
13+
## Getting Started
14+
15+
### Installation
16+
17+
```bash
18+
npm install
19+
```
20+
21+
### Development
22+
23+
```bash
24+
npm run dev
25+
```
26+
27+
Visit `http://localhost:3000` to view the documentation site.
28+
29+
### Build
30+
31+
```bash
32+
npm run build
33+
```
34+
35+
### Production
36+
37+
```bash
38+
npm start
39+
```
40+
41+
## Building Multi-language Documentation
42+
43+
For a comprehensive guide on how to build and maintain multi-language documentation, see the [Multi-language Documentation Guide](content/docs/i18n-guide.en.mdx) available in the documentation:
44+
45+
- English: `/en/docs/i18n-guide`
46+
- Chinese: `/zh-CN/docs/i18n-guide`
47+
48+
The guide covers:
49+
- Configuration setup
50+
- Creating multi-language content
51+
- File naming conventions
52+
- Adding new languages
53+
- Troubleshooting common issues
54+
355
## Configuration Notes
456

557
### Internationalization (i18n)
658

7-
The default language is configured in `lib/i18n.ts` as `en`. If you change the default language, you must also update the redirect destination in `vercel.json` to match (currently `/en/docs`).
59+
The default language is configured in `lib/i18n.ts` as `en`. If you change the default language, you must also update the redirect destination in `vercel.json` to match (currently `/en/docs`).
60+
61+
### Content Structure
62+
63+
Content files are located in `content/docs/` and use language suffixes:
64+
- `{filename}.en.mdx` - English content
65+
- `{filename}.zh-CN.mdx` - Chinese content
66+
- `meta.en.json` - English navigation
67+
- `meta.zh-CN.json` - Chinese navigation

0 commit comments

Comments
 (0)