---
title: LDesign文档系统
description: 基于vue3和markdown的文档系统，通过简单的markdown语法快速完成功能丰富的文档内容。
---

## 初始化

文档系统依托`[http://npm.longrise.cn:6286/-/web/detail/@ldesign/cli](http://npm.longrise.cn:6286/-/web/detail/@ldesign/cli)`使用，通过脚手架可快速创建一个文档系统模板。

``` shell
ldesign init
```

!!! ldesign-image /images/1.png
!!!

接下来在选择模板的时候，选择`文档`即可。

## 安装项目依赖

该项目安装依赖只可通过`ldesign`命令，其他方式皆不可用。

``` bash
ldesign i  //推荐
ldesign install
```

## 开发

通过`dev`命令可启动一个本地服务，默认端口为：`3000`，也可自行修改。

``` bash
npm run dev
```

## 打包发布

通过`build`命令将文档打包成静态页面，最终只需将`dist`目录部署到服务器相对应的位置即可。

``` bash
npm run build
```

## 目录结构说明

- `docs`  用于存放`markdown`文件以及其他文档所用到示例代码
- `public` 用于存放文档的图片资源，建议放置在`public/images`里面。
- `doc.config.js` 文档的菜单配置，最多支持`2`层菜单
- `index.html` 文档的入口，可添加其他依赖包以及对文档的配置。
- `vite.config.js` 文档启动、打包的配置文件，切勿修改。
