aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/packages/docs/README.md
diff options
context:
space:
mode:
author简律纯 <i@jyunko.cn>2026-02-23 17:18:10 +0800
committerGitHub <noreply@github.com>2026-02-23 17:18:10 +0800
commit8facaa33ba1b590684671d66d55eeeeb868f119c (patch)
treeea919235694d1151ec16e5542eca6e858b5bb30d /packages/docs/README.md
parent01b546cc816c4fb6b7389e5122b7802d7e724a2b (diff)
parent83cab95205b2a42d8a1efffbe76b0f0b8fa26eab (diff)
downloadDropOut-8facaa33ba1b590684671d66d55eeeeb868f119c.tar.gz
DropOut-8facaa33ba1b590684671d66d55eeeeb868f119c.zip
Merge branch 'main' into refactor/migrate-to-react
Diffstat (limited to 'packages/docs/README.md')
-rw-r--r--packages/docs/README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/packages/docs/README.md b/packages/docs/README.md
index 63b9290..f4e7563 100644
--- a/packages/docs/README.md
+++ b/packages/docs/README.md
@@ -5,6 +5,7 @@ This is the official documentation site for DropOut Minecraft Launcher, built wi
## Overview
The documentation covers:
+
- **Getting Started**: Installation and first-time setup
- **Features**: Detailed guides for all launcher features
- **Architecture**: Technical design and implementation details
@@ -14,6 +15,7 @@ The documentation covers:
### Multi-language Support
The documentation is available in:
+
- **English** (default) - `content/docs/en/`
- **简体中文** (Simplified Chinese) - `content/docs/zh/`
@@ -68,7 +70,7 @@ pnpm format
## Project Structure
-```
+```bash
packages/docs/
├── content/
│ └── docs/ # Documentation content (MDX)
@@ -97,6 +99,7 @@ packages/docs/
### Structure
Documentation is organized by locale:
+
- English: `content/docs/en/`
- Chinese: `content/docs/zh/`
@@ -105,6 +108,7 @@ 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
@@ -160,6 +164,7 @@ Fumadocs provides several components:
### Translation Guidelines
When translating content:
+
- Keep all code blocks in English
- Translate frontmatter (title, description)
- Keep technical terms (Tauri, Rust, Svelte, etc.) in English