# LiteBot Docs

**Repository Path**: litebot/litebot-docs

## Basic Information

- **Project Name**: LiteBot Docs
- **Description**: LiteBot文档中心
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-04-07
- **Last Updated**: 2022-04-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 🌟 LiteBot 文档中心

LiteBot configuration guide, tutorial, API documentation

[English](./README.md) | 简体中文

## 🚀 访问地址

[https://docs.litebot-bds.top](https://docs.litebot-bds.top)

## ✨ 文档撰写

### 准备工作

1. 克隆本仓库

```bash
git clone git@github.com:LiteBot-BDS/LiteBot-Docs.git
```

2. 进入仓库目录，安装依赖模块：

```bash
cd LiteBot-Docs
npm install --save
```

3. 进入 docs 目录，开始编写文档

### 目录介绍

```
├── docs                   文档存放路径
│   ├── index.md           首页展示
│   └── **.**              网站目录文档
├── src                    组件主目录
│   ├── index.ts           组件注册
│   └── Foo                组件开发
├── .eslintrc.js           eslint 配置
├── .fatherrc.ts           father 配置
├── .umirc.ts              dumi 配置
└── tsconfig.json          typescript 配置
```

### 命令介绍

| 名称                    | 描述           | 备注                                                                 |
| ----------------------- | -------------- | -------------------------------------------------------------------- |
| `npm run start`         | 项目启动       | 使用 [dumi](https://github.com/umijs/dumi)，组件开发和文档开发在一起 |
| `npm run test`          | 组件测试       | -                                                                    |
| `npm run test:coverage` | 代码覆盖率查看 | -                                                                    |
| `npm run prettier`      | 代码美化       | -                                                                    |
| `npm run build`         | 组件打包       | 使用 [father](https://github.com/umijs/father) 工具                  |
| `npm run release`       | 组件打包发布   | -                                                                    |
| `npm run docs:build`    | 文档打包       | -                                                                    |
| `npm run docs:deploy`   | 文档发布       | 这里默认是使用了 GitHub Pages                                        |
| `npm run deploy`        | 文档打包发布   | -                                                                    |

### 更多内容

请参阅 dumi 文档：[https://d.umijs.org/zh-CN/guide](https://d.umijs.org/zh-CN/guide)