# MKFramework

**Repository Path**: lshrimp-game/MKFramework

## Basic Information

- **Project Name**: MKFramework
- **Description**: cocos creator 3.x游戏开发框架
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 52
- **Created**: 2023-08-23
- **Last Updated**: 2023-08-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MKFramework

muzzik 开发的 cocos creator 3.x 游戏开发框架 `(beta 阶段)`，欢迎在 issue 中提出需求/bug

> 开发路线图：https://trello.com/b/ymt0NYYy

---

## # 在任意项目中安装框架

[https://github.com/1226085293/mk_framework/releases/tag/%E5%AE%89%E8%A3%85%E6%8F%92%E4%BB%B6](https://github.com/1226085293/mk_framework/wiki/%E5%AE%89%E8%A3%85%E7%A8%8B%E5%BA%8F)

## # 构建框架声明文件(d.ts)

### 1. 初始化

1. `cd tool\api-extractor`

2. `npm i`

### 2. 运行

1. `npm run 构建框架声明文件`

## # 构建框架文档
> 仅限 mk_framework 项目

### 1. 初始化

1. `cd tool\doc-website`

2. `npm i`

### 2. 运行

1. `cd tool\api-extractor & npm run 构建框架文档`

2. `cd tool\doc-website & npm run start`