Skip to content

docs: setup vitepress #507

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 24, 2021
Merged

docs: setup vitepress #507

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dee34c2
docs: install vitepress
ktsn Oct 6, 2020
eba2046
docs: update docs config for vitepress
ktsn Jan 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 90 additions & 0 deletions docs/.vitepress/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
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',
},
],
},
],
},
},
}
52 changes: 0 additions & 52 deletions docs/.vuepress/config.js
View file
Open in desktop

This file was deleted.

0 docs/api/README.md → docs/api/index.md
View file
Open in desktop
File renamed without changes.
0 docs/README.md → docs/index.md
View file
Open in desktop
File renamed without changes.
6 changes: 4 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down Expand Up @@ -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",
Expand Down
Loading