# plantdata-cd-backend-docs

**Repository Path**: lixwei/plantdata-cd-backend-docs

## Basic Information

- **Project Name**: plantdata-cd-backend-docs
- **Description**: 海乂知成都后端技术文档
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-02-22
- **Last Updated**: 2026-05-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


## 安装和启动

如有问题，请联系李星伟 **[文档源码地址](https://gitee.com/lixwei/plantdata-cd-backend-docs)**

::: warning
Node请使用>=18.0.0版本。
:::

```shell
# 克隆项目
git clone https://gitee.com/lixwei/plantdata-cd-backend-docs.git

# 进入文件夹
cd plantdata-cd-backend-docs

# 安装依赖 注意：如安装不成功请关闭淘宝源。
npm install # or yarn install

# 启动项目
npm run dev:win
```

## 新增文档

::: warning
编写文档前请查看两个教程， **[文档框架教程](https://doc.xugaoyi.com/)** ， **[Markdown 教程](https://www.runoob.com/markdown/md-tutorial.html)**
:::

1. 在对应目录中增加文档文件，命名规则为 {序号}.文档名称.md
2. 增加文件头信息

```
---
author: 
  name: 作者名称
title: 文档名称
---

# 文档名称

todo 文档内容
```

3. 编写文档内容

4. 启动项目查看效果

```shell
npm run dev:win
```

5. 通过git提交文档代码

## 部署文档

### 构建打包

1. 在项目根目录下执行构建命令：

```shell
npm run build:win
```

2. 构建完成后，会在项目根目录生成 `docs/.vuepress/dist` 文件夹，该文件夹包含所有静态资源文件。

### 上传部署

1. 将 `docs/.vuepress/dist/*` 文件夹中的所有文件复制到目标服务器 `192.169.4.55` 的 `/work/front/plantdata-cd-backend-docs` 目录下。