From 3fb2c4b81db5a9fd5e2ea1e2a7512f106e09c5b5 Mon Sep 17 00:00:00 2001 From: Jacco van den Berg Date: Wed, 26 May 2021 01:16:12 +0200 Subject: [PATCH] show the utils file in the samples page to clarify what the functions do --- docs/.vuepress/config.js | 1 + docs/samples/utils.md | 14 ++++++++++++++ 2 files changed, 15 insertions(+) create mode 100644 docs/samples/utils.md diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 80cc8ff314b..ee97448b535 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -264,6 +264,7 @@ module.exports = { 'plugins/quadrants', ] }, + 'utils' ], '/': [ '', diff --git a/docs/samples/utils.md b/docs/samples/utils.md new file mode 100644 index 00000000000..a1e8faf3f31 --- /dev/null +++ b/docs/samples/utils.md @@ -0,0 +1,14 @@ +# Utils + +## Disclaimer +The Utils file contains multiple helper functions that the chart.js sample pages use to generate charts. +These functions are subject to change, including but not limited to breaking changes without prior notice. + +Because of this please don't rely on this file in production environments. + +## Functions + +<<< @/docs/scripts/utils.js + +[File on github](https://github.com/chartjs/Chart.js/blob/master/docs/scripts/utils.js) +