Initial commit
This commit is contained in:
103
README-VITEPRESS.md
Normal file
103
README-VITEPRESS.md
Normal file
@@ -0,0 +1,103 @@
|
||||
# VitePress 使用手册
|
||||
|
||||
基于 VitePress 构建的使用手册。
|
||||
|
||||
## 📖 文档预览
|
||||
|
||||
本手册采用 VitePress 构建,支持实时预览和静态站点生成。
|
||||
|
||||
## 🚀 快速开始
|
||||
|
||||
### 准备package.json文件
|
||||
|
||||
文件夹下具备 package.json 文件
|
||||
|
||||
json文件结构如下:
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "docs-vitepress",
|
||||
"version": "1.0.0",
|
||||
"description": "vitepress在线文档",
|
||||
"scripts": {
|
||||
"docs:dev": "vitepress dev docs",
|
||||
"docs:build": "vitepress build docs",
|
||||
"docs:preview": "vitepress preview docs",
|
||||
"export-pdf": "press-export-pdf export docs"
|
||||
},
|
||||
"devDependencies": {
|
||||
"vitepress": "latest",
|
||||
"vitepress-export-pdf": "^1.0.0"
|
||||
}
|
||||
}
|
||||
```
|
||||
### 安装依赖
|
||||
|
||||
执行以下命令安装依赖:
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
### 开发预览
|
||||
|
||||
```bash
|
||||
npm run docs:dev
|
||||
```
|
||||
|
||||
### 构建静态站点
|
||||
|
||||
```bash
|
||||
npm run docs:build
|
||||
```
|
||||
|
||||
### 预览构建结果
|
||||
|
||||
```bash
|
||||
npm run docs:preview
|
||||
```
|
||||
|
||||
## 📁 文档结构
|
||||
|
||||
```
|
||||
docs/
|
||||
├── .vitepress/
|
||||
│ └── config.mjs # VitePress 配置
|
||||
├── guide/ # 文档说明
|
||||
│ ├── document-guide.md
|
||||
│ └── system-overview.md
|
||||
├── getting-started/ # 快速入门
|
||||
│ └── quick-start.md
|
||||
├── basic/ # 基础配置
|
||||
│ ├── data-management.md
|
||||
│ └── equipment.md
|
||||
├── business/ # 业务模块
|
||||
│ ├── production.md
|
||||
│ ├── quality.md
|
||||
│ └── equipment-warehouse.md
|
||||
├── integration/ # 数据集成
|
||||
│ └── data-integration.md
|
||||
├── analysis/ # 报表分析
|
||||
│ └── reports.md
|
||||
├── operation/ # 系统运维
|
||||
│ ├── system-operation.md
|
||||
│ └── technical-support.md
|
||||
├── appendix/ # 附录
|
||||
│ └── glossary.md
|
||||
└── index.md # 首页
|
||||
```
|
||||
|
||||
## 🔧 配置说明
|
||||
|
||||
VitePress 配置文件位于 `docs/.vitepress/config.mjs`,包含以下配置:
|
||||
|
||||
- 网站标题和描述
|
||||
- 导航栏配置
|
||||
- 侧边栏配置
|
||||
- 主题配置
|
||||
- Markdown 配置
|
||||
|
||||
## 📦 技术栈
|
||||
|
||||
- [VitePress](https://vitepress.dev/) - Vite 驱动的静态站点生成器
|
||||
- [Vue.js](https://vuejs.org/) - 渐进式 JavaScript 框架
|
||||
|
||||
Reference in New Issue
Block a user