# vue3-naiveui-admin-docs

**Repository Path**: zimo493/vue3-naiveui-admin-docs

## Basic Information

- **Project Name**: vue3-naiveui-admin-docs
- **Description**: 🎈 vue3-naiveui-admin文档站点
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://www.youlai.tech/naiveui-docs
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-06-05
- **Last Updated**: 2025-10-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Vue, TypeScript

## README

# Vue3 NaiveUI Admin 文档站点

基于 `VitePress` 构建的 Vue3 NaiveUI Admin 中后台管理系统文档站点。

## 项目介绍

> [🔗Vue3 NaiveUI Admin](https://gitee.com/zimo493/vue3-naiveui-admin) 是一个基于 `Vue3` `TypeScript` `NaiveUI` `UnoCSS` 等最新技术栈开发的中后台管理系统模板。本仓库为其官方文档站点，提供了详细的使用指南和 API 文档。

## 技术栈

- [🔗VitePress](https://vitepress.dev/) 基于 Vite 和 Vue 的静态站点生成器
- [🔗Vue3](https://vuejs.org/) 渐进式 JavaScript 框架
- [🔗Naive UI](https://www.naiveui.com/) 一个 Vue3 组件库，使用 TypeScript
- [🔗Nólëbase](https://nolebase-integrations.ayaka.io/pages/zh-CN/) 多元化的文档工程工具合集
- [🔗FancyApps UI](https://fancyapps.com/) 现代和功能丰富的JavaScript工具包，帮助创建引人入胜和功能丰富的用户体验

## 本地开发

### 安装依赖

```bash
pnpm install
```

### 启动开发服务器

```bash
pnpm dev
```

### 构建文档站点

```bash
pnpm build
```

### 本地预览构建结果

```bash
pnpm preview
```

## 项目结构

```

├── .vitepress/         # VitePress 配置
│   ├── config/          # 配置文件目录
│   └── theme/           # 主题配置
├── src/                # 文档内容
|   ├── components/      # 组件封装
|   ├── dev/             # 开发配置
|   ├── en/              # 英文文档
|   ├── faq/             # 常见问题
|   ├── guide/           # 指南
|   ├── index.md         # 首页
|   └── logo.svg         # 项目 Logo
├── .gitignore          # Git 忽略文件
├── config.ts           # 配置文件
├── package.json        # 项目配置文件
├── pnpm-lock.yaml      # 依赖锁定文件
├── tsconfig.json       # TypeScript 配置文件
└── README.md           # 项目文档
```

## 多语言支持

本文档站点支持中文和英文两种语言：

- 中文（默认）：`/`
- 英文：`/en/`

## 贡献指南

欢迎提交 [🔗Issue](https://github.com/zimo493/vue3-naiveui-admin-docs/issues/new) 或 [🔗Pull Request](https://github.com/zimo493/vue3-naiveui-admin-docs/pulls) 来帮助改进文档！