Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ecomfe/san-mui

A Set of SAN Components that Implement Google's Material Design
https://github.com/ecomfe/san-mui

material-design san

Last synced: about 2 months ago
JSON representation

A Set of SAN Components that Implement Google's Material Design

Awesome Lists containing this project

README

        

# san-mui

A Set of SAN Components that Implement Google's Material Design

[![Build Status](https://travis-ci.org/ecomfe/san-mui.svg?style=flat)](https://travis-ci.org/ecomfe/san-mui)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/ecomfe/san-mui/master/LICENSE)

## 使用指南

1. 通过 npm 安装

```sh
npm i -S san-mui
```

2. 在代码中引入

```js
// 引入需要的组件
import {Button, DatePicker} from 'san-mui';

// 引入全部样式
import 'san-mui/lib/index.css';
```

或者希望只引入需要的组件,可以这么做:

```js
import Button from 'san-mui/lib/Button';
import 'san-mui/lib/Button/Button.css';
```

## 开发指南

### 开发

```sh
npm run dev
```

### 测试

```sh
npm test
```

### 构建

我们的源码存放在 `src`,构建产物放在 `lib` 下;

启动构建命令:

```sh
npm run build
```

## 发布指南

### 发布源

只发布到 npm 上;

### 发布内容

发布内容应该只包含 package.json / readme.md / lib

### 发布版本

两周内发版本 [email protected] 系列

两周到一个月之内版本:[email protected]

一个月至两个月内:[email protected]

最终版本 [email protected]

[email protected]版本对应的san的版本为3.2.3

[email protected]版本对应的san的版本为3.5.2 源码对应的是version-3.3.x分支