未验证 提交 70680d78 编写于 作者: K Katashin 提交者: GitHub

docs: setup vitepress (#507)

* docs: install vitepress

* docs: update docs config for vitepress
上级 53c0535c
module.exports = {
title: 'Vue Class Component',
description:
'ECMAScript / TypeScript decorator for class-style Vue components',
themeConfig: {
repo: 'vuejs/vue-class-component',
docsDir: 'docs',
editLinks: true,
nav: [
{
text: 'Guide',
link: '/',
},
{
text: 'API Reference',
link: '/api/',
},
],
sidebar: {
'/api/': [
{
text: 'API Reference',
link: '/api/',
},
],
'/': [
{
text: 'Overview',
link: '/',
},
{
text: 'Installation',
link: '/guide/installation.html',
},
{
text: 'General Guide',
collapsable: false,
children: [
{
text: 'Class Component',
link: '/guide/class-component.html',
},
{
text: 'Additional Hooks',
link: '/guide/additional-hooks.html',
},
{
text: 'Custom Decorators',
link: '/guide/custom-decorators.html',
},
{
text: 'Extend and Mixins',
link: '/guide/extend-and-mixins.html',
},
{
text: 'Caveats of Class Component',
link: '/guide/caveats.html',
},
],
},
{
text: 'TypeScript Guide',
collapsable: false,
children: [
{
text: 'Props Definition',
link: '/guide/props-definition.html',
},
{
text: 'Property Type Declaration',
link: '/guide/property-type-declaration.html',
},
{
text: '$refs Type Extension',
link: '/guide/refs-type-extension.html',
},
{
text: 'Hooks Auto-complete',
link: '/guide/hooks-auto-complete.html',
},
],
},
],
},
},
}
module.exports = {
title: 'Vue Class Component',
description:
'ECMAScript / TypeScript decorator for class-style Vue components',
themeConfig: {
repo: 'vuejs/vue-class-component',
docsDir: 'docs',
editLinks: true,
nav: [
{
text: 'Guide',
link: '/',
},
{
text: 'API Reference',
link: '/api/',
},
],
sidebar: {
'/api/': [''],
'/': [
'',
'guide/installation.md',
{
title: 'General Guide',
collapsable: false,
children: [
'guide/class-component.md',
'guide/additional-hooks.md',
'guide/custom-decorators.md',
'guide/extend-and-mixins.md',
'guide/caveats.md',
],
},
{
title: 'TypeScript Guide',
collapsable: false,
children: [
'guide/props-definition.md',
'guide/property-type-declaration.md',
'guide/refs-type-extension.md',
'guide/hooks-auto-complete.md',
],
},
],
},
},
}
......@@ -25,8 +25,9 @@
"test:ts": "jest",
"test:babel": "cross-env BABEL_TEST=1 jest",
"test:dts": "tsc -p ./test-dts",
"docs:dev": "vuepress dev docs",
"docs:build": "vuepress build docs",
"docs:dev": "vitepress dev docs",
"docs:build": "vitepress build docs",
"docs:serve": "vitepress serve docs",
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
"release": "bash scripts/release.sh"
},
......@@ -75,6 +76,7 @@
"ts-loader": "^8.0.2",
"typescript": "^4.0.2",
"uglify-es": "^3.3.9",
"vitepress": "^0.11.4",
"vue": "^3.0.0",
"vue-loader": "^16.1.1",
"webpack": "^4.44.1",
......
此差异已折叠。
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册