open-index/open-npm huggingface dataset:
npm package: @free-design/c-xxx
Description: 组件化开发
Latest version: 1.1.6

# Arco 物料模板

## 快速开始

```
// 开发模式
npm run dev

// 构建
npm run build

// 生成元数据 arcoMeta
arco generate

// 发布包
arco publish

// 查看当前 arco-scripts 使用的配置
npm run show:config -- webpack:component
```

## API 文档

**为了帮助他人更好地使用你的组件，请提供详细的 API 文档。**

### 书写注释

我们提供了自动化的文档生成工具，它从 TS 接口定义中提取注释自动生成属性文档。按照以下指引使用，为接口书写 tsDoc 类型的注释：

```typescript
/**
 * @title Button (必填，带有 `title` 描述的接口或者类型才会被收集)
 */
interface ButtonProps {
  /**
   * @zh 按钮尺寸 (属性的中文描述)
   * @en Size of Button (属性的英文描述)
   * @version 1.2.0 (可选，新增的属性在哪个版本开始支持)
   * @default 'default' (可选，属性的默认值)
   */
  size?: 'mini' | 'small' | 'default' | 'large';
  /**
   * @zh 按钮状态
   * @en Status of Button
   */
  status?: 'danger' | 'error' | 'success';
}
```

### 扩展 TEMPLATE.md

`TEMPLATE.md` 是用于自动文档生成的模板，你可以修改此文件添加更多组件的使用帮助信息，但请不要删除其原有的内容，否则可能导致内容替换失败。

```markdown
// TEMPLATE.md
---
file: index
---

# TooltipButton

## 属性/Props

%%Props%%

### OtherProps

在这里你可以书写更多组件帮助文档。

## Demos

%%Demos%%
```

## 测试

测试目录位于 `src/__test__`。你可以在 `index.test.tsx` 中编写你的测试用例，在 `demo.test.tsx` 中可以进行基于 Demo 的快照测试。

`npm run test` 命令允许你传入任何 `jest` 的命令行参数，例如 `npm run test -- --u` `npm run test -- --no-cache`。

## DEMO

Demo 目录位于 `src/demo`。 如果你添加了一个 Demo，那么你需要在 `src/demo/index.js` 添加对应代码，才能在 Storybook 中预览到它。请使用 JsDoc 的形式描述各个 Demo，这些帮助信息将被展示在物料平台上。

[查看完整帮助文档](https://arco.design/cli)
npm package: @free-design/rc-xxx
Description: 组件化开发
Latest version: 1.1.0

# Arco 物料模板

## 快速开始

```
// 开发模式
npm run dev

// 构建
npm run build

// 生成元数据 arcoMeta
arco generate

// 发布包
arco publish

// 查看当前 arco-scripts 使用的配置
npm run show:config -- webpack:component
```

## API 文档

**为了帮助他人更好地使用你的组件，请提供详细的 API 文档。**

### 书写注释

我们提供了自动化的文档生成工具，它从 TS 接口定义中提取注释自动生成属性文档。按照以下指引使用，为接口书写 tsDoc 类型的注释：

```typescript
/**
 * @title Button (必填，带有 `title` 描述的接口或者类型才会被收集)
 */
interface ButtonProps {
  /**
   * @zh 按钮尺寸 (属性的中文描述)
   * @en Size of Button (属性的英文描述)
   * @version 1.2.0 (可选，新增的属性在哪个版本开始支持)
   * @default 'default' (可选，属性的默认值)
   */
  size?: 'mini' | 'small' | 'default' | 'large';
  /**
   * @zh 按钮状态
   * @en Status of Button
   */
  status?: 'danger' | 'error' | 'success';
}
```

### 扩展 TEMPLATE.md

`TEMPLATE.md` 是用于自动文档生成的模板，你可以修改此文件添加更多组件的使用帮助信息，但请不要删除其原有的内容，否则可能导致内容替换失败。

```markdown
// TEMPLATE.md
---
file: index
---

# TooltipButton

## 属性/Props

%%Props%%

### OtherProps

在这里你可以书写更多组件帮助文档。

## Demos

%%Demos%%
```

## 测试

测试目录位于 `src/__test__`。你可以在 `index.test.tsx` 中编写你的测试用例，在 `demo.test.tsx` 中可以进行基于 Demo 的快照测试。

`npm run test` 命令允许你传入任何 `jest` 的命令行参数，例如 `npm run test -- --u` `npm run test -- --no-cache`。

## DEMO

Demo 目录位于 `src/demo`。 如果你添加了一个 Demo，那么你需要在 `src/demo/index.js` 添加对应代码，才能在 Storybook 中预览到它。请使用 JsDoc 的形式描述各个 Demo，这些帮助信息将被展示在物料平台上。

[查看完整帮助文档](https://arco.design/cli)
npm package: @free-design/test-code
Description: dada
Latest version: 0.1.4

# Arco 物料模板

## 快速开始

```
// 开发模式
npm run dev

// 构建
npm run build

// 生成元数据 arcoMeta
arco generate

// 发布包
arco publish

// 查看当前 arco-scripts 使用的配置
npm run show:config -- webpack:component
```

## API 文档

**为了帮助他人更好地使用你的组件，请提供详细的 API 文档。**

### 书写注释

我们提供了自动化的文档生成工具，它从 TS 接口定义中提取注释自动生成属性文档。按照以下指引使用，为接口书写 tsDoc 类型的注释：

```typescript
/**
 * @title Button (必填，带有 `title` 描述的接口或者类型才会被收集)
 */
interface ButtonProps {
  /**
   * @zh 按钮尺寸 (属性的中文描述)
   * @en Size of Button (属性的英文描述)
   * @version 1.2.0 (可选，新增的属性在哪个版本开始支持)
   * @default 'default' (可选，属性的默认值)
   */
  size?: 'mini' | 'small' | 'default' | 'large';
  /**
   * @zh 按钮状态
   * @en Status of Button
   */
  status?: 'danger' | 'error' | 'success';
}
```

### 扩展 TEMPLATE.md

`TEMPLATE.md` 是用于自动文档生成的模板，你可以修改此文件添加更多组件的使用帮助信息，但请不要删除其原有的内容，否则可能导致内容替换失败。

```markdown
// TEMPLATE.md
---
file: index
---

# TooltipButton

## 属性/Props

%%Props%%

### OtherProps

在这里你可以书写更多组件帮助文档。

## Demos

%%Demos%%
```

## 测试

测试目录位于 `src/__test__`。你可以在 `index.test.tsx` 中编写你的测试用例，在 `demo.test.tsx` 中可以进行基于 Demo 的快照测试。

`npm run test` 命令允许你传入任何 `jest` 的命令行参数，例如 `npm run test -- --u` `npm run test -- --no-cache`。

## DEMO

Demo 目录位于 `src/demo`。 如果你添加了一个 Demo，那么你需要在 `src/demo/index.js` 添加对应代码，才能在 Storybook 中预览到它。请使用 JsDoc 的形式描述各个 Demo，这些帮助信息将被展示在物料平台上。

[查看完整帮助文档](https://arco.design/cli)
npm package: @free-design/testcode
Description: free des
Latest version: 0.1.6

# Arco 物料模板

## 快速开始

```
// 开发模式
npm run dev

// 构建
npm run build

// 生成元数据 arcoMeta
arco generate

// 发布包
arco publish

// 查看当前 arco-scripts 使用的配置
npm run show:config -- webpack:component
```

## API 文档

**为了帮助他人更好地使用你的组件，请提供详细的 API 文档。**

### 书写注释

我们提供了自动化的文档生成工具，它从 TS 接口定义中提取注释自动生成属性文档。按照以下指引使用，为接口书写 tsDoc 类型的注释：

```typescript
/**
 * @title Button (必填，带有 `title` 描述的接口或者类型才会被收集)
 */
interface ButtonProps {
  /**
   * @zh 按钮尺寸 (属性的中文描述)
   * @en Size of Button (属性的英文描述)
   * @version 1.2.0 (可选，新增的属性在哪个版本开始支持)
   * @default 'default' (可选，属性的默认值)
   */
  size?: 'mini' | 'small' | 'default' | 'large';
  /**
   * @zh 按钮状态
   * @en Status of Button
   */
  status?: 'danger' | 'error' | 'success';
}
```

### 扩展 TEMPLATE.md

`TEMPLATE.md` 是用于自动文档生成的模板，你可以修改此文件添加更多组件的使用帮助信息，但请不要删除其原有的内容，否则可能导致内容替换失败。

```markdown
// TEMPLATE.md
---
file: index
---

# TooltipButton

## 属性/Props

%%Props%%

### OtherProps

在这里你可以书写更多组件帮助文档。

## Demos

%%Demos%%
```

## 测试

测试目录位于 `src/__test__`。你可以在 `index.test.tsx` 中编写你的测试用例，在 `demo.test.tsx` 中可以进行基于 Demo 的快照测试。

`npm run test` 命令允许你传入任何 `jest` 的命令行参数，例如 `npm run test -- --u` `npm run test -- --no-cache`。

## DEMO

Demo 目录位于 `src/demo`。 如果你添加了一个 Demo，那么你需要在 `src/demo/index.js` 添加对应代码，才能在 Storybook 中预览到它。请使用 JsDoc 的形式描述各个 Demo，这些帮助信息将被展示在物料平台上。

[查看完整帮助文档](https://arco.design/cli)
npm package: @free-kits/rmake
Description: Set up a modern web app by running one command.
Author: zhangj
Latest version: 0.2.0-canary

# @free-kits/rmake

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/b4cae52220c4433a8d8b813cf50433ad)](https://app.codacy.com/gh/free-kits/rmake?utm_source=github.com&utm_medium=referral&utm_content=free-kits/rmake&utm_campaign=Badge_Grade)
[![codecov](https://codecov.io/gh/free-kits/rmake/branch/canary/graph/badge.svg?token=ZX8NIV3186)](https://codecov.io/gh/free-kits/rmake)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ffree-kits%2Fdt-doc.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Ffree-kits%2Fdt-doc?ref=badge_shield)
[![@free-kits/rmake](https://img.shields.io/npm/v/@free-kits/rmake/latest)](https://www.npmjs.com/package/@free-kits/rmake)

## Introduction

![image](https://user-images.githubusercontent.com/24241052/106423297-2053bf80-649b-11eb-83f3-2a81247832af.png)

Feature

- 🌈 Out of the box.
- ✍ Build documentation, and react components.
- 🐱‍🏍 Based on webpack 5.

## Thanks

- The software is inspired by [https://github.com/umijs/dumi](https://github.com/umijs/dumi)
- The page design style comes from [https://material.io/](https://material.io/)
- Homepage image from [https://web.dev/](https://web.dev/)

## License

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ffree-kits%2Frmake.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Ffree-kits%2Frmake?ref=badge_large)