docs: add vitepress documents

pull/126/head
Kia Ishii 5 years ago
parent 6931ebd22a
commit 96b5218056

2
.gitignore vendored

@ -1,4 +1,6 @@
/dist /dist
/docs/node_modules
/docs/src/.vitepress/dist
/node_modules /node_modules
/src/client/shared /src/client/shared
/src/node/shared /src/node/shared

@ -0,0 +1,10 @@
{
"private": true,
"scripts": {
"dev": "vitepress dev src",
"build": "vitepress build src"
},
"devDependencies": {
"vitepress": "^0.7.2"
}
}

@ -0,0 +1,28 @@
module.exports = {
lang: 'en-US',
title: 'VitePress',
description: 'Vite & Vue powered static site generator.',
themeConfig: {
repo: 'vuejs/vitepress',
docsDir: 'docs',
editLinkText: 'Edit this page on GitHub',
nav: [
{ text: 'Guide', link: '/guide/what-is-vitepress' },
{
text: 'Release Notes',
link: 'https://github.com/vuejs/vitepress/releases'
}
],
sidebar: [
{
text: 'Introduction',
children: [
{ text: 'What is VitePress?', link: '/guide/what-is-vitepress' }
]
}
]
}
}

@ -0,0 +1,3 @@
# What is VitePress
Hello, world!

@ -0,0 +1,7 @@
---
home: true
---
# Home
Hello, world!

File diff suppressed because it is too large Load Diff

@ -35,7 +35,9 @@
"dev-watch": "node scripts/watchAndCopy", "dev-watch": "node scripts/watchAndCopy",
"build": "rimraf -rf dist && node scripts/copyShared && tsc -p src/client && tsc -p src/node && node scripts/copyClient", "build": "rimraf -rf dist && node scripts/copyShared && tsc -p src/client && tsc -p src/node && node scripts/copyClient",
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s", "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
"release": "bash scripts/release.sh" "release": "bash scripts/release.sh",
"docs": "cd docs && yarn dev",
"docs-build": "cd docs && yarn build"
}, },
"engines": { "engines": {
"node": ">=10.0.0" "node": ">=10.0.0"

Loading…
Cancel
Save