# cookie

**Repository Path**: dataocean/cook

## Basic Information

- **Project Name**: cookie
- **Description**: 一个React文档小工具
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-04-11
- **Last Updated**: 2025-09-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: React, JavaScript, Documentation

## README

# Cookie组件文档化展示工具

![项目示例](Example.png)

一个用于管理和展示React组件文档的系统。

## 功能特性

- 自动扫描项目中的React组件
- 展示组件文档和参数信息
- 统计组件数量
- 支持Markdown格式的文档
- 支持参数类型和默认值

## 安装

```bash
npm install
npm run dev
```
## 使用方法

```bash
npm install -g https://gitee.com/dataocean/cook/releases/download/latest/cookie.tgz
cd your-local-react-project
cookie
``` 

1. 全局安装后，在需要扫描的React项目目录下执行cookie命令
2. 系统会自动扫描项目中的React组件
3. 左侧菜单会显示所有扫描到的组件
4. 点击组件名称查看详细文档和参数信息


## 技术栈

- React
- Ant Design
- Redux
- React Router