Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 61 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,67 @@
# docs

A multi-language documentation site built with Fumadocs, supporting English and Chinese.

## Features

- 🌍 **Multi-language Support**: Full internationalization with English (en) and Chinese (zh-CN)
- 📝 **MDX Content**: Write documentation using MDX for interactive content
- 🔍 **Fast Search**: Quick search across all documentation
- 🎨 **Modern UI**: Beautiful and responsive design with Fumadocs UI
- 📱 **Mobile Friendly**: Fully responsive on all devices

## Getting Started

### Installation

```bash
npm install
```

### Development

```bash
npm run dev
```

Visit `http://localhost:3000` to view the documentation site.

### Build

```bash
npm run build
```

### Production

```bash
npm start
```

## Building Multi-language Documentation

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:

- English: `/en/docs/i18n-guide`
- Chinese: `/zh-CN/docs/i18n-guide`

The guide covers:
- Configuration setup
- Creating multi-language content
- File naming conventions
- Adding new languages
- Troubleshooting common issues

## Configuration Notes

### Internationalization (i18n)

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`).
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`).

### Content Structure

Content files are located in `content/docs/` and use language suffixes:
- `{filename}.en.mdx` - English content
- `{filename}.zh-CN.mdx` - Chinese content
- `meta.en.json` - English navigation
- `meta.zh-CN.json` - Chinese navigation
Loading
Loading