Skip to content

Commit

Permalink
Update the contributing guide for Docusaurus (#7327)
Browse files Browse the repository at this point in the history
  • Loading branch information
benmccann authored May 8, 2020
1 parent 8afa990 commit 00f726b
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions docs/docs/developers/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,20 @@ The following commands are now available from the repository root:
> gulp lint // perform code linting (ESLint)
> gulp test // perform code linting and run unit tests
> gulp test --browsers ... // test with specified browsers (comma-separated)
> gulp docs // build the documentation in ./dist/docs
> gulp docs --watch // starts the gitbook live reloaded server
```

More information can be found in [gulpfile.js](https://github.com/chartjs/Chart.js/blob/master/gulpfile.js).

### Documentation

We use [Docusaurus v2](https://v2.docusaurus.io/docs/introduction) to manage the docs which are contained as Markdown files in the docs directory. You can run the doc server locally using the commands provided by Docusaurus:

```
$ cd docs
$ npm install
$ npm run start
```

### Image-Based Tests

Some display-related functionality is difficult to test via typical Jasmine units. For this reason, we introduced image-based tests ([#3988](https://github.com/chartjs/Chart.js/pull/3988) and [#5777](https://github.com/chartjs/Chart.js/pull/5777)) to assert that a chart is drawn pixel-for-pixel matching an expected image.
Expand Down

0 comments on commit 00f726b

Please sign in to comment.