From 00f726b0eaeeaad177ded228a00cb4c4e0c9e529 Mon Sep 17 00:00:00 2001 From: Ben McCann <322311+benmccann@users.noreply.github.com> Date: Fri, 8 May 2020 08:09:37 -0700 Subject: [PATCH] Update the contributing guide for Docusaurus (#7327) --- docs/docs/developers/contributing.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/docs/developers/contributing.md b/docs/docs/developers/contributing.md index 396cb3e85..e5392658c 100644 --- a/docs/docs/developers/contributing.md +++ b/docs/docs/developers/contributing.md @@ -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. -- 2.47.2