# zrender-doc

**Repository Path**: justBreak/zrender-doc

## Basic Information

- **Project Name**: zrender-doc
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-03-31
- **Last Updated**: 2021-04-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ZRender Documentation

[![Build Status](https://travis-ci.org/ecomfe/zrender-doc.svg?branch=master)](https://travis-ci.org/ecomfe/zrender-doc)

## Installation

Before you start and run this project, make sure you have `Nodejs` and `gulp` installed. And if you want to build the source on Windows, you will also need to install `Ruby` and `Bundler`

> If you have problems installing Jekyll, please refer to [Jekyll's official site](https://jekyllrb.com/docs/installation/).

Install `gulp`

```
npm i -g gulp
```

Install dependencies

```
npm i
```

Copy asset files (css, js, ...) to source directory:

```
gulp
```

## Preview

To preview docs, simply run `npm start`, then open [http://localhost:4000/](http://localhost:4000/) in your browser, you can change the default url and port in `./src/_config.yml`

## Build

Open another terminal window and:

```
npm run build  # build documentation to dist
```