Skip to content

Commit f3a2120

Browse files
committed
docs: bump vitepress
1 parent 04fb431 commit f3a2120

File tree

6 files changed

+2526
-2428
lines changed

6 files changed

+2526
-2428
lines changed

.npmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
legacy-peer-deps=true
Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,23 @@
1-
const path = require('path')
1+
import { defineConfig } from 'vitepress'
22

3-
module.exports = {
3+
export default defineConfig({
44
title: 'G2Plot Vue',
55
description: 'G2Plot for Vue',
66
themeConfig: {
7+
logo: '/logo.svg',
78
nav: [
89
{ text: 'Guide', link: '/guide/' },
910
{ text: 'Demo', link: '/demo/' },
1011
{ text: 'Github', link: 'https://github.com/open-data-plan/g2plot-vue' },
1112
{
1213
text: 'Changelog',
13-
link:
14-
'https://github.com/open-data-plan/g2plot-vue/blob/master/CHANGELOG.md',
14+
link: 'https://github.com/open-data-plan/g2plot-vue/blob/master/CHANGELOG.md',
1515
},
1616
{ text: 'G2Plot', link: 'https://g2plot.antv.vision' },
1717
],
18+
footer: {
19+
message: 'MIT Licensed',
20+
copyright: 'Copyright © 2020-present Open Data Plan',
21+
},
1822
},
19-
}
23+
})

docs/guide/index.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,16 @@ title: Guide
1313
- Native support for `TypeScript`.
1414
- **100%** unit test coverage
1515

16-
## Installation
16+
## Install
17+
18+
```
19+
npm install @opd/g2plot-vue
20+
```
21+
22+
`g2plot-vue` will auto switch export version based on your installed `vue` version, if not work, you can switch by follow:
1723

1824
```bash
19-
npm i @opd/g2plot-vue @antv/g2plot
25+
node ./node_modules/@opd/g2plot-vue/scripts/postinstall.js
2026
```
2127

2228
## Usage

docs/index.md

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,18 @@
11
---
2-
home: true
3-
heroText: G2Plot Vue
4-
heroImage: /logo.svg
5-
actionText: Get Started
6-
actionLink: /guide/
2+
layout: home
3+
hero:
4+
name: G2Plot Vue
5+
text: For vue, both v2 and v3
6+
tagline: Builtin universal component support with vue-demi
7+
actions:
8+
- theme: brand
9+
text: Get Started
10+
link: /guide/
711
features:
812
- title: Both Vue 2&3
913
details: Universal support with vue-demi
1014
- title: G2Plot
1115
details: Powered by G2Plot
1216
- title: TypeScript
1317
details: Fully type definitions support
14-
footer: MIT Licensed | Copyright © 2020-present Open Data Plan
1518
---
16-
17-
## Install
18-
19-
```
20-
npm install @opd/g2plot-vue
21-
```
22-
23-
`g2plot-vue` will auto switch export version based on your installed `vue` version, if not work, you can switch by follow:
24-
25-
```bash
26-
node ./node_modules/@opd/g2plot-vue/scripts/postinstall.js
27-
```

0 commit comments

Comments
 (0)