# xianyou-admin-document

**Repository Path**: xianyouhu/xianyou-admin-document

## Basic Information

- **Project Name**: xianyou-admin-document
- **Description**: xianyou-admin的官方文档
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-19
- **Last Updated**: 2026-08-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# XianYou Admin 官方文档

官网：**https://xianyou-admin.cn**  
源码：**https://gitee.com/xianyouhu/xianyou-admin-base**

基于 [VitePress](https://vitepress.dev/) 的静态文档站，介绍 AdminBase 通用权限管理平台。纯 Markdown，构建后不依赖后端 API。

生产部署在站点根路径 `/`（与 `/web/base`、`/mobile/base` 并列）。

## 安装

```bash
cd xianyou-admin-document
npm install
```

## 本地开发

```bash
npm run docs:dev
```

浏览器访问终端输出的 Local 地址（默认 `http://localhost:5180`，避开 Web 端 5173）。

## 生产构建

```bash
npm run docs:build
```

本地预览构建结果：

```bash
npm run docs:preview
```

产物目录：

```
docs/.vitepress/dist/
  index.html
  assets/
```

## 打包成 tar.gz（给服务器上传）

阿里云网页一次只能传一个文件。Windows 10 自带 `tar`。

在仓库根目录 `AdminBase` 的上一级（工作区根）执行：

```powershell
tar -czf .\AdminBase\publish\xianyou-admin-docs.tar.gz -C .\xianyou-admin-document\docs\.vitepress\dist .
```

- `-c` 打包，`-z` gzip，`-f` 文件名
- `-C 目录 .`：先进入产物目录再打包，避免解压多套一层文件夹

核对：

```powershell
tar -tzf .\AdminBase\publish\xianyou-admin-docs.tar.gz
```

第一行应是 `./index.html`。

## 上传到服务器并解压

1. 把 `AdminBase/publish/xianyou-admin-docs.tar.gz` 传到服务器 `/opt/adminbase/`
2. SSH 执行：

```bash
tar -xzf /opt/adminbase/xianyou-admin-docs.tar.gz -C /var/www/xianyou-admin-site
```

成功通常不打印。浏览器 **Ctrl+F5** 后打开 `http://xianyou-admin.cn/`。

更完整的 tar 说明：`Notes/Linux/tar.gz打包与解压笔记.md`。

## 说明

- 文档源码在 `docs/`
- 站点配置：`docs/.vitepress/config.ts`（`base: '/'`）
- 不要把文档 dist 解压进 `web/base` 或 `mobile/base`