https://github.com/ecomfe/zrender-doc
Document for zrender
https://github.com/ecomfe/zrender-doc
Last synced: 11 months ago
JSON representation
Document for zrender
- Host: GitHub
- URL: https://github.com/ecomfe/zrender-doc
- Owner: ecomfe
- Created: 2017-09-04T07:49:14.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-09-16T07:13:05.000Z (almost 4 years ago)
- Last Synced: 2025-05-25T08:05:23.349Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://ecomfe.github.io/zrender-doc/public/
- Size: 669 KB
- Stars: 24
- Watchers: 18
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ZRender Documentation
[](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
```