diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..c70fc2a --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,57 @@ +# CLAUDE.md + +This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. + +## 项目概述 + +这是 AcePanel(服务器运维管理面板)的官方文档网站,使用 VitePress 构建,支持多语言(简体中文、繁体中文、英文)。 + +## 常用命令 + +```bash +# 安装依赖 +pnpm install + +# 启动开发服务器 +pnpm dev + +# 构建生产版本 +pnpm build + +# 预览构建结果 +pnpm preview +``` + +## 项目架构 + +### 目录结构 + +- `en/` - 英文文档(源语言,Crowdin 翻译源) +- `zh_CN/` - 简体中文文档 +- `zh_TW/` - 繁体中文文档 +- `.vitepress/config/` - VitePress 配置 + - `index.ts` - 主配置入口,定义多语言 locales + - `shared.ts` - 共享配置(markdown 插件、主题配置等) + - `en.ts` / `zh_CN.ts` / `zh_TW.ts` - 各语言独立配置(导航、侧边栏) +- `.vitepress/theme/` - 自定义主题扩展 +- `public/` - 静态资源 + +### 多语言机制 + +- 简体中文 (`zh_CN`) 是根路由,通过 `rewrites` 配置映射到根路径 +- 英文和繁体中文分别在 `/en/` 和 `/zh_TW/` 路径下 +- 使用 Crowdin 进行翻译管理,英文为源语言 + +### 版本历史 + +版本数据从 `https://api.acepanel.net/versions` API 动态获取,在配置文件构建时拉取最新 10 个版本。 + +### 使用的 VitePress 插件 + +- `@shikijs/vitepress-twoslash` - TypeScript 代码悬浮提示 +- `vitepress-plugin-group-icons` - 代码块分组图标 +- `vitepress-markdown-timeline` - 时间线组件 + +## 部署 + +推送到 `main` 分支会自动触发 GitHub Actions 部署到 GitHub Pages。 diff --git a/en/index.md b/en/index.md index 327fd77..737a0bc 100644 --- a/en/index.md +++ b/en/index.md @@ -43,21 +43,24 @@ features:
- WeiXiaoDuo + WeiXiaoDuo - LF Cloud + LF Cloud + + + Pangu Cloud - WAFPRO + WAFPRO - DunYun SCDN + DunYun SCDN - Kuocai CDN + Kuocai CDN - Millisecond Mirror + Millisecond Mirror
diff --git a/en/quickstart/container.md b/en/quickstart/container.md index b3f2237..9c658e4 100644 --- a/en/quickstart/container.md +++ b/en/quickstart/container.md @@ -6,20 +6,20 @@ After the container engine is installed, you can go to the Panel's container man First, navigate to the Images tab to pull the required images. This may take several minutes to tens of minutes depending on your network environment. -![Pull Image](/container1.png) +![Pull Image](/images/container/container1.png) After the image is pulled, navigate to the Containers tab to start creating a container. -![Create Container](/container2.png) +![Create Container](/images/container/container2.png) Fill in the form according to the container's instructions. The pgadmin4 image used here needs to map port 80 and configure 2 default environment variables, with no need to map directories. After the container is created, you can click the refresh button in the upper right corner and the log button on the right side of the container to check if it has started properly. -![Container Start](/container3.png) +![Container Start](/images/container/container3.png) If the container fails to start, please make corrections according to the logs. If you have mapped external ports, you need to go to the firewall menu to allow the corresponding ports. -![Creation Successful](/container4.png) +![Creation Successful](/images/container/container4.png) diff --git a/public/container1.png b/public/images/container/container1.png similarity index 100% rename from public/container1.png rename to public/images/container/container1.png diff --git a/public/container2.png b/public/images/container/container2.png similarity index 100% rename from public/container2.png rename to public/images/container/container2.png diff --git a/public/container3.png b/public/images/container/container3.png similarity index 100% rename from public/container3.png rename to public/images/container/container3.png diff --git a/public/container4.png b/public/images/container/container4.png similarity index 100% rename from public/container4.png rename to public/images/container/container4.png diff --git a/public/1ms.svg b/public/partners/1ms.svg similarity index 100% rename from public/1ms.svg rename to public/partners/1ms.svg diff --git a/public/ddunyun.png b/public/partners/ddunyun.png similarity index 100% rename from public/ddunyun.png rename to public/partners/ddunyun.png diff --git a/public/dk.png b/public/partners/dk.png similarity index 100% rename from public/dk.png rename to public/partners/dk.png diff --git a/public/kuocai.png b/public/partners/kuocai.png similarity index 100% rename from public/kuocai.png rename to public/partners/kuocai.png diff --git a/public/partners/pangu.png b/public/partners/pangu.png new file mode 100644 index 0000000..7df8a0e Binary files /dev/null and b/public/partners/pangu.png differ diff --git a/public/wafpro.png b/public/partners/wafpro.png similarity index 100% rename from public/wafpro.png rename to public/partners/wafpro.png diff --git a/public/wxd.png b/public/partners/wxd.png similarity index 100% rename from public/wxd.png rename to public/partners/wxd.png diff --git a/zh_CN/index.md b/zh_CN/index.md index 8c59026..ea237e5 100644 --- a/zh_CN/index.md +++ b/zh_CN/index.md @@ -42,21 +42,21 @@ features: ## 合作伙伴
- WeiXiaoDuo + WeiXiaoDuo - LF Cloud + LF Cloud - WAFPRO + WAFPRO - DunYun SCDN + DunYun SCDN - Kuocai CDN + Kuocai CDN - Millisecond Mirror + Millisecond Mirror
diff --git a/zh_CN/quickstart/container.md b/zh_CN/quickstart/container.md index 05fe80e..da3283b 100644 --- a/zh_CN/quickstart/container.md +++ b/zh_CN/quickstart/container.md @@ -6,20 +6,20 @@ 首先导航到镜像选项卡拉取需要的镜像。 视网络环境可能需要数分钟到数十分钟。 -![拉取镜像](/container1.png) +![拉取镜像](/images/container/container1.png) 镜像拉取完成后,导航到容器选项卡开始创建容器。 -![创建容器](/container2.png) +![创建容器](/images/container/container2.png) 表单内容按容器的说明填写。 此处使用的 pgadmin4 镜像需要映射 80 端口及配置 2 个默认环境变量,无需映射目录。 容器创建完成后可点击右上角刷新按钮和容器右侧的日志按钮检查是否正常启动。 -![容器启动](/container3.png) +![容器启动](/images/container/container3.png) 若容器未能启动,请根据日志进行修正。 如果映射了外部端口,需要到防火墙菜单放行相应的端口。 -![创建成功](/container4.png) +![创建成功](/images/container/container4.png) diff --git a/zh_TW/index.md b/zh_TW/index.md index d53f2a9..3750138 100644 --- a/zh_TW/index.md +++ b/zh_TW/index.md @@ -42,21 +42,21 @@ features: ## 合作夥伴
- WeiXiaoDuo + WeiXiaoDuo - LinFeng Cloud + LinFeng Cloud - WAFPRO + WAFPRO - DunYun SCDN + DunYun SCDN - Kuocai CDN + Kuocai CDN - Millisecond Mirror + Millisecond Mirror
diff --git a/zh_TW/quickstart/container.md b/zh_TW/quickstart/container.md index cf05f12..2bc5060 100644 --- a/zh_TW/quickstart/container.md +++ b/zh_TW/quickstart/container.md @@ -6,20 +6,20 @@ 首先導航到鏡像選項卡拉取需要的鏡像。 視網路環境可能需要數分鐘到數十分鐘。 -![拉取鏡像](/container1.png) +![拉取鏡像](/images/container/container1.png) 鏡像拉取完成後,導航到容器選項卡開始創建容器。 -![創建容器](/container2.png) +![創建容器](/images/container/container2.png) 表單內容按容器的說明填寫。 此處使用的 pgadmin4 鏡像需要映射 80 端口及配置 2 個默認環境變數,無需映射目錄。 容器創建完成後可點擊右上角刷新按鈕和容器右側的日誌按鈕檢查是否正常啟動。 -![容器啟動](/container3.png) +![容器啟動](/images/container/container3.png) 若容器未能啟動,請根據日誌進行修正。 如果映射了外部端口,需要到防火牆菜單放行相應的端口。 -![創建成功](/container4.png) +![創建成功](/images/container/container4.png)