Skip to content

Commit eba2046

Browse files
committed
docs: update docs config for vitepress
1 parent dee34c2 commit eba2046

File tree

3 files changed

+570
-933
lines changed

3 files changed

+570
-933
lines changed

docs/.vitepress/config.js

Lines changed: 52 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,30 +20,68 @@ module.exports = {
2020
],
2121

2222
sidebar: {
23-
'/api/': [''],
23+
'/api/': [
24+
{
25+
text: 'API Reference',
26+
link: '/api/',
27+
},
28+
],
2429

2530
'/': [
26-
'',
27-
'guide/installation.md',
2831
{
29-
title: 'General Guide',
32+
text: 'Overview',
33+
link: '/',
34+
},
35+
{
36+
text: 'Installation',
37+
link: '/guide/installation.html',
38+
},
39+
{
40+
text: 'General Guide',
3041
collapsable: false,
3142
children: [
32-
'guide/class-component.md',
33-
'guide/additional-hooks.md',
34-
'guide/custom-decorators.md',
35-
'guide/extend-and-mixins.md',
36-
'guide/caveats.md',
43+
{
44+
text: 'Class Component',
45+
link: '/guide/class-component.html',
46+
},
47+
{
48+
text: 'Additional Hooks',
49+
link: '/guide/additional-hooks.html',
50+
},
51+
{
52+
text: 'Custom Decorators',
53+
link: '/guide/custom-decorators.html',
54+
},
55+
{
56+
text: 'Extend and Mixins',
57+
link: '/guide/extend-and-mixins.html',
58+
},
59+
{
60+
text: 'Caveats of Class Component',
61+
link: '/guide/caveats.html',
62+
},
3763
],
3864
},
3965
{
40-
title: 'TypeScript Guide',
66+
text: 'TypeScript Guide',
4167
collapsable: false,
4268
children: [
43-
'guide/props-definition.md',
44-
'guide/property-type-declaration.md',
45-
'guide/refs-type-extension.md',
46-
'guide/hooks-auto-complete.md',
69+
{
70+
text: 'Props Definition',
71+
link: '/guide/props-definition.html',
72+
},
73+
{
74+
text: 'Property Type Declaration',
75+
link: '/guide/property-type-declaration.html',
76+
},
77+
{
78+
text: '$refs Type Extension',
79+
link: '/guide/refs-type-extension.html',
80+
},
81+
{
82+
text: 'Hooks Auto-complete',
83+
link: '/guide/hooks-auto-complete.html',
84+
},
4785
],
4886
},
4987
],

package.json

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@
2525
"test:ts": "jest",
2626
"test:babel": "cross-env BABEL_TEST=1 jest",
2727
"test:dts": "tsc -p ./test-dts",
28-
"docs:dev": "vitepress --root docs",
29-
"docs:build": "vitepress build --root docs",
28+
"docs:dev": "vitepress dev docs",
29+
"docs:build": "vitepress build docs",
30+
"docs:serve": "vitepress serve docs",
3031
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
3132
"release": "bash scripts/release.sh"
3233
},
@@ -75,7 +76,7 @@
7576
"ts-loader": "^8.0.2",
7677
"typescript": "^4.0.2",
7778
"uglify-es": "^3.3.9",
78-
"vitepress": "^0.6.0",
79+
"vitepress": "^0.11.4",
7980
"vue": "^3.0.0",
8081
"vue-loader": "^16.1.1",
8182
"webpack": "^4.44.1",

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy