open-index/open-npm huggingface dataset:
npm package: @marsjs/components
Description: mars components for h5 target
Latest version: 1.0.47

# mars-components

## 环境依赖

- php v5.6+
- node v8+

## Get Started

组件库代码库：http://icode.baidu.com/repo/baidu%2Fps-se-fe-tpl%2Fsearch-ui/files/master/tree/

```
npm install
apmjs install
```

## 本地开发

```shell
npm run serve -- [options] [组件...]
```

```
  Options:

    --open    open browser on server start
    --copy    copy url to clipboard on server start
    --host    specify host (default: 0.0.0.0)
    --port    specify port (default: 8080)
    --https   use https (default: false)
    --public  specify the public network URL for the HMR client
```

> windows 下运行时执行会报错，可以暂时吧 node_modues/@baidu/atom-web-server-runtime/php/Atom_Component_Creator.php 中第 34 行的 `$componentPath[0] === DIRECTORY_SEPARATOR && ` 这段代码删掉

## 文档自动生成

执行

```shell
npm run docs
```

文档书写参考：http://icode.baidu.com/repos/baidu/atom/atom-docgen-api/tree/master

> 注意：
> 1. 该命令会删除 readme.md 内 API 之后的所有内容
> 2. 暂时需要在 `build/gendoc.js` 内添加白名单