feat(i18n): add multilingual support with translations for English, Japanese, and Simplified Chinese
- Create README.md for internationalization (i18n) documentation - Add English translation for main README and quick start guide - Add Japanese translation for main README - Add Simplified Chinese translation for main README - Introduce sample Docker Compose configurations for various deployment scenarios - Implement CI/CD documentation for testing and deployment workflows - Establish end-to-end testing guidelines and strategies - Create test strategy documentation outlining unit, integration, and E2E tests
This commit is contained in:
Your Name
parent
b3b382d1e0
commit
da856d89ff
42 changed files with 4901 additions and 263 deletions
95
docs/i18n/en/README.md
Normal file
95
docs/i18n/en/README.md
Normal file
|
|
@ -0,0 +1,95 @@
|
|||
# ConvertX-CN Documentation
|
||||
|
||||
> 🌐 **Language / 語言**
|
||||
> [繁體中文](../../README.md) | **English** | [简体中文](../zh-CN/README.md)
|
||||
|
||||
> 🌐 **Translation Info**
|
||||
>
|
||||
> - Original: [繁體中文版](../../README.md)
|
||||
> - Translation Version: v0.1.0
|
||||
> - Last Updated: 2026-01-23
|
||||
> - Status: 🚧 In Progress
|
||||
|
||||
---
|
||||
|
||||
Welcome to ConvertX-CN Documentation! Choose your role to find the information you need.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
New to ConvertX-CN? Start here:
|
||||
|
||||
1. **[Overview](getting-started/overview.md)** — What is ConvertX-CN
|
||||
2. **[Quick Start](getting-started/quick-start.md)** — Deploy in 5 minutes
|
||||
3. **[FAQ](getting-started/faq.md)** — Common questions
|
||||
|
||||
---
|
||||
|
||||
## 👤 User Guide
|
||||
|
||||
For general users:
|
||||
|
||||
| Document | Description |
|
||||
| ---------------------------------------------- | ------------------------------------ |
|
||||
| [Quick Start](getting-started/quick-start.md) | Fastest deployment method |
|
||||
| [Supported Converters](features/converters.md) | All available formats |
|
||||
| [OCR](features/ocr.md) | Optical Character Recognition |
|
||||
| [Translation](features/translation.md) | PDF translation (preserves formulas) |
|
||||
| [Languages](features/i18n.md) | Interface language settings |
|
||||
| [FAQ](getting-started/faq.md) | Frequently Asked Questions |
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Administrator Guide
|
||||
|
||||
For deployment and maintenance:
|
||||
|
||||
### Deployment
|
||||
|
||||
| Document | Description |
|
||||
| -------------------------------------------- | --------------------------- |
|
||||
| [Docker Deployment](deployment/docker.md) | Docker Run & Docker Compose |
|
||||
| [Reverse Proxy](deployment/reverse-proxy.md) | Nginx / Traefik / Caddy |
|
||||
| [Sample Configs](samples/README.md) | Ready-to-use configurations |
|
||||
|
||||
### Configuration
|
||||
|
||||
| Document | Description |
|
||||
| --------------------------------------------------------------- | --------------------------------- |
|
||||
| [Environment Variables](configuration/environment-variables.md) | All available settings |
|
||||
| [Security](configuration/security.md) | HTTPS, authentication, protection |
|
||||
| [Cleanup & Limits](configuration/limits-and-cleanup.md) | Auto cleanup, resource limits |
|
||||
|
||||
---
|
||||
|
||||
## 👩💻 Developer Guide
|
||||
|
||||
For contributors and extension development:
|
||||
|
||||
### Development
|
||||
|
||||
| Document | Description |
|
||||
| ----------------------------------------------------- | --------------------- |
|
||||
| [Project Structure](development/project-structure.md) | Code structure |
|
||||
| [Local Development](development/local-development.md) | Dev environment setup |
|
||||
| [Contribution Guide](development/contribution.md) | How to contribute |
|
||||
|
||||
### API
|
||||
|
||||
| Document | Description |
|
||||
| --------------------------------- | ------------------ |
|
||||
| [API Overview](api/overview.md) | REST & GraphQL API |
|
||||
| [API Endpoints](api/endpoints.md) | Endpoint details |
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Quick Links
|
||||
|
||||
- 📦 [GitHub Repo](https://github.com/pi-docket/ConvertX-CN)
|
||||
- 🐛 [Issues](https://github.com/pi-docket/ConvertX-CN/issues)
|
||||
- 💬 [Discussions](https://github.com/pi-docket/ConvertX-CN/discussions)
|
||||
|
||||
---
|
||||
|
||||
> 💡 **Can't find what you need?** Ask in [GitHub Discussions](https://github.com/pi-docket/ConvertX-CN/discussions)!
|
||||
139
docs/i18n/en/getting-started/quick-start.md
Normal file
139
docs/i18n/en/getting-started/quick-start.md
Normal file
|
|
@ -0,0 +1,139 @@
|
|||
# Quick Start
|
||||
|
||||
> 🌐 **Language / 語言**
|
||||
> [繁體中文](../../getting-started/quick-start.md) | **English** | [简体中文](../zh-CN/getting-started/quick-start.md)
|
||||
|
||||
> 🌐 **Translation Info**
|
||||
>
|
||||
> - Original: [繁體中文版](../../getting-started/quick-start.md)
|
||||
> - Translation Version: v0.1.0
|
||||
> - Last Updated: 2026-01-23
|
||||
> - Status: 🚧 In Progress
|
||||
|
||||
---
|
||||
|
||||
Deploy ConvertX-CN in 5 minutes.
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Docker 20.10+ ([Install Guide](https://docs.docker.com/get-docker/))
|
||||
- 4GB+ RAM
|
||||
- 10GB+ Disk Space
|
||||
|
||||
---
|
||||
|
||||
## Method 1: Docker Run (Fastest)
|
||||
|
||||
### 1. Create Data Folder
|
||||
|
||||
```bash
|
||||
# Linux / macOS
|
||||
mkdir -p ~/convertx-cn/data && cd ~/convertx-cn
|
||||
|
||||
# Windows PowerShell
|
||||
mkdir C:\convertx-cn\data; cd C:\convertx-cn
|
||||
|
||||
# Windows CMD
|
||||
mkdir C:\convertx-cn\data
|
||||
cd C:\convertx-cn
|
||||
```
|
||||
|
||||
### 2. Start Container
|
||||
|
||||
```bash
|
||||
docker run -d \
|
||||
--name convertx-cn \
|
||||
--restart unless-stopped \
|
||||
-p 3000:3000 \
|
||||
-v ./data:/app/data \
|
||||
-e TZ=Asia/Taipei \
|
||||
-e JWT_SECRET=your-random-string-at-least-32-chars \
|
||||
convertx/convertx-cn:latest
|
||||
```
|
||||
|
||||
### 3. Start Using
|
||||
|
||||
Open browser: `http://localhost:3000`
|
||||
|
||||
1. Click **Register** in the top right corner
|
||||
2. Enter Email and Password
|
||||
3. Done! Start converting files
|
||||
|
||||
---
|
||||
|
||||
## Method 2: Docker Compose (Recommended)
|
||||
|
||||
### 1. Create Project Folder
|
||||
|
||||
```bash
|
||||
mkdir -p ~/convertx-cn && cd ~/convertx-cn
|
||||
```
|
||||
|
||||
### 2. Create Configuration File
|
||||
|
||||
Create `docker-compose.yml`:
|
||||
|
||||
```yaml
|
||||
services:
|
||||
convertx:
|
||||
image: convertx/convertx-cn:latest
|
||||
container_name: convertx-cn
|
||||
restart: unless-stopped
|
||||
ports:
|
||||
- "3000:3000"
|
||||
volumes:
|
||||
- ./data:/app/data
|
||||
environment:
|
||||
- TZ=Asia/Taipei
|
||||
- JWT_SECRET=please-replace-with-a-long-random-string
|
||||
```
|
||||
|
||||
### 3. Start Service
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Verify Installation
|
||||
|
||||
### Check Container Status
|
||||
|
||||
```bash
|
||||
docker ps
|
||||
# Should see convertx-cn container running
|
||||
|
||||
docker logs convertx-cn
|
||||
# Should see "🦊 Elysia is running at http://localhost:3000"
|
||||
```
|
||||
|
||||
### Health Check
|
||||
|
||||
```bash
|
||||
curl http://localhost:3000/healthcheck
|
||||
# Should return "OK"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Startup Issues
|
||||
|
||||
| Issue | Solution |
|
||||
| ------------------------------- | --------------------------------------------- |
|
||||
| Port already in use | Use another port, e.g., `-p 8080:3000` |
|
||||
| Redirected to login after login | Add `HTTP_ALLOWED=true` or `TRUST_PROXY=true` |
|
||||
| Logged out after restart | Set a fixed `JWT_SECRET` |
|
||||
| Data lost after restart | Confirm `./data:/app/data` and folder exists |
|
||||
| Permission error | Run `chmod -R 777 ./data` |
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
- 📖 [Docker Configuration](../deployment/docker.md)
|
||||
- ⚙️ [Environment Variables](../configuration/environment-variables.md)
|
||||
- 🔒 [Security Settings](../configuration/security.md)
|
||||
- 🔧 [Reverse Proxy Setup](../deployment/reverse-proxy.md)
|
||||
Loading…
Add table
Add a link
Reference in a new issue