Skip to content

Commit 846aad6

Browse files
bavocobavoco
committed
refactor: vuepress to vitepress
1 parent bfd207d commit 846aad6

14 files changed

Lines changed: 6097 additions & 31080 deletions

File tree

‎.github/workflows/documentation.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
- uses: actions/checkout@v2
1515
- uses: actions/setup-node@v2
1616
with:
17-
node-version: 16
17+
node-version: 18
1818
- name: Test Build
1919
run: |
2020
npm ci
@@ -27,7 +27,7 @@ jobs:
2727
- uses: actions/checkout@v2
2828
- uses: actions/setup-node@v2
2929
with:
30-
node-version: 16
30+
node-version: 18
3131
- name: Build
3232
run: |
3333
npm ci

‎.github/workflows/publish-npm.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ jobs:
3535
- uses: actions/checkout@v2
3636
- uses: actions/setup-node@v2
3737
with:
38-
node-version: 16
38+
node-version: 18
3939
registry-url: https://registry.npmjs.org/
4040
- name: Setup and build
4141
run: |
@@ -106,7 +106,7 @@ jobs:
106106
- uses: actions/checkout@v2
107107
- uses: actions/setup-node@v2
108108
with:
109-
node-version: 16
109+
node-version: 18
110110
registry-url: https://registry.npmjs.org/
111111

112112
- name: Build docs (latest/next)

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ build/
1414
# generated typedocs
1515
docs/api
1616

17+
docs/.vitepress/dist
18+
docs/.vitepress/cache
19+
1720
# Development
1821
.DS_Store
1922
.env.local

‎docs/.vitepress/config.mjs‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
import { defineConfig } from 'vitepress'
2+
const docsVersion = "VERSION";
3+
const base = process.env.NODE_ENV === "development" ? '/chartjs-plugin-zoom/master/' : `/chartjs-plugin-zoom/${docsVersion}/`;
4+
5+
// https://vitepress.dev/reference/site-config
6+
export default defineConfig({
7+
title: "chartjs-plugin-zoom",
8+
description: "A zoom and pan plugin for Chart.js >= 3.0.0",
9+
head: [
10+
['link', { rel: 'icon', href: '/favicon.ico' }],
11+
],
12+
base,
13+
outDir: '../../dist/docs',
14+
themeConfig: {
15+
// https://vitepress.dev/reference/default-theme-config
16+
logo: '/hero.svg',
17+
footer: {
18+
message: 'Released under the MIT License',
19+
copyright: 'Copyright © 2016-2024 chartjs-plugin-zoom contributors',
20+
},
21+
nav: [
22+
{
23+
text: docsVersion,
24+
items: [
25+
{ text: 'Development (master)', link: '/chartjs-plugin-zoom/master/' },
26+
{ text: '2.x.x', link: '/chartjs-plugin-zoom/2.0.1/' },
27+
{ text: '1.x.x', link: '/chartjs-plugin-zoom/1.3.0/' },
28+
],
29+
},
30+
{ text: 'Home', link: '/' },
31+
{ text: 'Guide', link: '/guide/integration' },
32+
{ text: 'Reference', link: '/api/README' },
33+
{ text: 'Samples', link: `/samples/` },
34+
{
35+
text: 'Ecosystem',
36+
ariaLabel: 'Community Menu',
37+
items: [
38+
{ text: 'Awesome', link: 'https://github.com/chartjs/awesome' },
39+
]
40+
},
41+
{ text: 'GitHub', link: 'https://github.com/chartjs/chartjs-plugin-zoom' },
42+
],
43+
44+
sidebar: [
45+
{
46+
text: 'Guide',
47+
collapsed: false,
48+
link: '/guide/integration',
49+
items: [
50+
{ text: 'Integration', link: '/guide/integration' },
51+
{ text: 'Usage', link: '/guide/usage' },
52+
{ text: 'Options', link: '/guide/options' },
53+
{ text: 'Animations', link: '/guide/animations' },
54+
{ text: 'Developers', link: '/guide/developers' },
55+
],
56+
},
57+
{
58+
text: 'Samples',
59+
collapsed: false,
60+
link: '/samples/basic',
61+
items: [
62+
{ text: 'Basic', link: '/samples/basic' },
63+
{
64+
text: 'Wheel Zoom',
65+
collapsed: true,
66+
items: [
67+
{ text: 'Category Scale', link: '/samples/wheel/category' },
68+
{ text: 'Logarithmic Scale', link: '/samples/wheel/log' },
69+
{ text: 'Time Scale', link: '/samples/wheel/time' },
70+
{ text: 'Over Scale Mode', link: '/samples/wheel/over-scale-mode' },
71+
{ text: 'Click to Zoom', link: '/samples/wheel/click-zoom' },
72+
],
73+
},
74+
{
75+
text: 'Drag to Zoom',
76+
collapsed: true,
77+
items: [
78+
{ text: 'Category Scale', link: '/samples/drag/category' },
79+
{ text: 'Linear Scale', link: '/samples/drag/linear' },
80+
{ text: 'Logarithmic Scale', link: '/samples/drag/log' },
81+
{ text: 'Time Scale', link: '/samples/drag/time' },
82+
{ text: 'Timeseries Scale', link: '/samples/drag/timeseries' },
83+
],
84+
},
85+
{ text: 'API', link: '/samples/api' },
86+
{ text: 'Fetch Data', link: '/samples/fetch-data' },
87+
{ text: 'Pan Region', link: '/samples/pan-region' },
88+
]
89+
},
90+
{
91+
text: 'API Reference',
92+
link: '/api/README',
93+
}
94+
],
95+
96+
socialLinks: [
97+
{ icon: 'github', link: 'https://github.com/chartjs/chartjs-plugin-zoom' },
98+
]
99+
}
100+
})

‎docs/.vuepress/config.js‎

Lines changed: 0 additions & 129 deletions
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,4 @@
1-
const path = require('path');
2-
const docsVersion = "VERSION";
3-
const base = process.env.NODE_ENV === "development" ? '/chartjs-plugin-zoom/master/' : `/chartjs-plugin-zoom/${docsVersion}/`;
41

5-
module.exports = {
6-
title: 'chartjs-plugin-zoom',
7-
description: 'A zoom and pan plugin for Chart.js >= 3.0.0',
8-
theme: 'chartjs',
9-
base,
10-
dest: path.resolve(__dirname, '../../dist/docs'),
11-
head: [
12-
['link', {rel: 'icon', href: '/favicon.ico'}],
13-
],
14-
plugins: [
15-
['flexsearch'],
16-
['redirect', {
17-
redirectors: [
18-
// Default sample page when accessing /samples.
19-
{base: '/samples', alternative: ['basic']},
20-
],
21-
}],
22-
[
23-
'vuepress-plugin-typedoc',
24-
{
25-
entryPoints: ['../../types/index.d.ts'],
26-
hideInPageTOC: true,
27-
tsconfig: 'tsconfig.json',
28-
sidebar: {
29-
fullNames: true,
30-
parentCategory: 'API',
31-
},
32-
},
33-
],
34-
['@simonbrunel/vuepress-plugin-versions', {
35-
filters: {
36-
suffix: (tag) => tag ? ` (${tag})` : '',
37-
title: (v, vars) => window.location.href.includes('master') ? 'Development (master)' : v + (vars.tag ? ` (${tag})` : ''),
38-
},
39-
menu: {
40-
text: '{{version|title}}',
41-
items: [
42-
{
43-
text: 'Documentation',
44-
items: [
45-
{
46-
text: 'Development (master)',
47-
link: '/chartjs-plugin-zoom/master/',
48-
target: '_self',
49-
},
50-
{
51-
type: 'versions',
52-
text: '{{version}}{{tag|suffix}}',
53-
link: '/chartjs-plugin-zoom/{{version}}/',
54-
exclude: /^[0]\.[0-4]\./,
55-
group: 'minor',
56-
target: '_self',
57-
}
58-
]
59-
},
60-
{
61-
text: 'Release notes (5 latest)',
62-
items: [
63-
{
64-
type: 'versions',
65-
limit: 5,
66-
target: '_blank',
67-
group: 'patch',
68-
link: 'https://github.com/chartjs/chartjs-plugin-zoom/releases/tag/v{{version}}'
69-
}
70-
]
71-
}
72-
]
73-
},
74-
}],
75-
],
762
chainWebpack: (config) => {
773
config.module
784
.rule('chart.js')
@@ -93,67 +19,12 @@ module.exports = {
9319
});
9420
},
9521
themeConfig: {
96-
repo: 'chartjs/chartjs-plugin-zoom',
97-
logo: '/favicon.ico',
98-
lastUpdated: 'Last Updated',
99-
searchPlaceholder: 'Search...',
100-
editLinks: false,
101-
docsDir: 'docs',
10222
chart: {
10323
imports: [
10424
['scripts/register.js'],
10525
['scripts/defaults.js'],
10626
['scripts/utils.js', 'Utils'],
10727
]
10828
},
109-
nav: [
110-
{text: 'Home', link: '/'},
111-
{text: 'Guide', link: '/guide/'},
112-
{text: 'API', link: '/api/'},
113-
{text: 'Samples', link: `/samples/`},
114-
{
115-
text: 'Ecosystem',
116-
ariaLabel: 'Community Menu',
117-
items: [
118-
{ text: 'Awesome', link: 'https://github.com/chartjs/awesome' },
119-
]
120-
}
121-
],
122-
sidebar: {
123-
'/guide/': [
124-
'',
125-
'integration',
126-
'usage',
127-
'options',
128-
'animations',
129-
'developers',
130-
],
131-
'/samples/': [
132-
'basic',
133-
{
134-
title: 'Wheel Zoom',
135-
children: [
136-
'wheel/category',
137-
'wheel/log',
138-
'wheel/time',
139-
'wheel/over-scale-mode',
140-
'wheel/click-zoom',
141-
]
142-
},
143-
{
144-
title: 'Drag to Zoom',
145-
children: [
146-
'drag/category',
147-
'drag/linear',
148-
'drag/log',
149-
'drag/time',
150-
'drag/timeseries',
151-
]
152-
},
153-
'api',
154-
'fetch-data',
155-
'pan-region',
156-
],
157-
}
15829
}
15930
};

‎docs/guide/index.md‎

Lines changed: 0 additions & 19 deletions
This file was deleted.

‎docs/index.md‎

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,21 @@
1-
---
2-
home: true
3-
heroImage: /hero.svg
4-
actionText: Get Started →
5-
actionLink: /guide/
6-
footer: MIT Licensed | Copyright © 2016-2021 chartjs-plugin-zoom contributors
7-
---
1+
![logo](/hero.svg)
2+
3+
# chartjs-plugin-zoom
4+
5+
A zoom and pan plugin for Chart.js >= 3.0.0
6+
7+
Panning can be done via the mouse or with a finger.
8+
Zooming is done via the mouse wheel or via a pinch gesture. [Hammer.js](https://hammerjs.github.io/) is used for gesture recognition.
9+
10+
## Installation
11+
12+
```bash
13+
> npm install chartjs-plugin-zoom
14+
```
15+
16+
:::tip
17+
18+
**Important Note:** For Chart.js 2.6.0 to 2.9.x support, use [version 0.7.7 of this plugin](https://github.com/chartjs/chartjs-plugin-zoom/releases/tag/v0.7.7).
19+
Documentation for v0.7.7 can be found on [GitHub](https://github.com/chartjs/chartjs-plugin-zoom/blob/v0.7.7/README.md).
20+
21+
:::

docs/.vuepress/public/favicon.ico renamed to docs/public/favicon.ico

File renamed without changes.

docs/.vuepress/public/favicon.png renamed to docs/public/favicon.png

File renamed without changes.

docs/.vuepress/public/hero.svg renamed to docs/public/hero.svg

File renamed without changes.

0 commit comments

Comments
 (0)