Browse Source

docs(CONTRIBUTING.md): how to build document site (#2355)

pull/2366/head
Yoshiya Hinosawa 6 years ago committed by GitHub
parent
commit
9ed959a851
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 22
      CONTRIBUTING.md

22
CONTRIBUTING.md

@ -39,6 +39,28 @@ This command will automatically run the specification suite and report its resul
If you want to see specs running live in browser (e.g., for debugging), simply open `http://localhost:9876/` in your browser when phantomjs starts.
## Building the document site (c3js.org)
First you need ruby and [bundler][] to build the documentation site.
```console
$ gem install bundler
```
Then you need to install bundler dependencies.
```console
$ bundle install
```
Then hit the following command to build the site.
```console
$ npm run watch:docs
```
Then access `http://0.0.0.0:4567`.
## Contributing your changes
Add something about PRs here, indicate that PRs should not bump the version number & the build output files (`c3.js`, `c3.min.js`, `c3.css` & `c3.min.css`) should be excluded

Loading…
Cancel
Save