From 5b6b812538893ad98a200347769fbc9c5504f716 Mon Sep 17 00:00:00 2001 From: stockiNail Date: Wed, 6 Apr 2022 16:44:36 +0200 Subject: [PATCH] Move v3-migration.md file in the documentation --- docs/.vuepress/config.js | 1 + v3-migration.md => docs/guide/migrationV1.md | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) rename v3-migration.md => docs/guide/migrationV1.md (88%) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 62719af3f..ae5af3031 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -98,6 +98,7 @@ module.exports = { 'types/polygon' ] }, + 'migrationV1', 'migrationV2' ], '/samples/': [ diff --git a/v3-migration.md b/docs/guide/migrationV1.md similarity index 88% rename from v3-migration.md rename to docs/guide/migrationV1.md index a7ff31c4b..4082542b6 100644 --- a/v3-migration.md +++ b/docs/guide/migrationV1.md @@ -1,10 +1,10 @@ -# 3.x Migration Guide +# 1.x Migration Guide -chartjs-plugin-annotation 3.0 introduces a number of breaking changes. +`chartjs-plugin-annotation` plugin version 1 introduces a number of breaking changes in order to compatible with Chart.js 3 and to align with Chart.js 3 options. ## Setup and installation -* Chart.js 3 is tree-shakeable and thus requires registering the plugins when used as an `npm` module. Here is an example: +Chart.js 3 is tree-shakeable and thus requires registering the plugins when used as an `npm` module. Here is an example: ```javascript import { Chart, LineController, LineElement, PointElement, LinearScale } from 'chart.js';