#  vite-component-doc-builder

**Repository Path**: linzowo/vite-component-doc-builder

## Basic Information

- **Project Name**:  vite-component-doc-builder
- **Description**: 基于vitepress-for-component的vue3文档项目，用于组件文档管理.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-05-19
- **Last Updated**: 2022-05-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# vite-component-doc-builder

一个基于`vite/vue3/vitepress-for-component`的组件文档管理项目，用于进行文档可视化，方便查找，查看，使用。

## 使用

1. Clone 仓库
2. 安装依赖 / Install dependencies
   ```
   yarn
   ```
3.  运行 / run demo
   ```bash
   yarn dev
   ```
   - 运行成功后你会看到如下信息:
   - If it's successful, you should see the following message:
   ```
   listening at http://localhost:3000
   ```
4. 进入查看效果

## 项目组织及其他详情

见 `docs\index.md`