Skip to content

Commit 5253901

Browse files
authored
docs: use vitepress next (#8233)
1 parent e37a51d commit 5253901

File tree

7 files changed

+116
-42
lines changed

7 files changed

+116
-42
lines changed

docs/.vitepress/config.ts

Lines changed: 41 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,42 @@ import { defineConfig } from 'vitepress'
33
export default defineConfig({
44
title: 'Vite',
55
description: 'Next Generation Frontend Tooling',
6-
head: [['link', { rel: 'icon', type: 'image/svg+xml', href: '/logo.svg' }]],
6+
7+
head: [
8+
['link', { rel: 'icon', type: 'image/svg+xml', href: '/logo.svg' }],
9+
10+
// TODO: This is neeeded to get smooth dark mode appearance on initial
11+
// load. And this will be gone when VitePress figures out how to handle
12+
// this in core.
13+
[
14+
'script',
15+
{},
16+
`
17+
;(() => {
18+
const saved = localStorage.getItem('vitepress-theme-appearance')
19+
const prefereDark = window.matchMedia('(prefers-color-scheme: dark)').matches
20+
21+
if (!saved || saved === 'auto' ? prefereDark : saved === 'dark') {
22+
document.documentElement.classList.add('dark')
23+
}
24+
})()
25+
`
26+
]
27+
],
28+
729
vue: {
830
reactivityTransform: true
931
},
32+
1033
themeConfig: {
11-
repo: 'vitejs/vite',
1234
logo: '/logo.svg',
13-
docsDir: 'docs',
14-
docsBranch: 'main',
15-
editLinks: true,
16-
editLinkText: 'Suggest changes to this page',
35+
36+
editLink: {
37+
repo: 'vitejs/vite',
38+
branch: 'main',
39+
dir: 'docs',
40+
text: 'Suggest changes to this page'
41+
},
1742

1843
algolia: {
1944
apiKey: 'b573aa848fd57fb47d693b531297403c',
@@ -28,6 +53,14 @@ export default defineConfig({
2853
placement: 'vitejsdev'
2954
},
3055

56+
localeLinks: {
57+
text: 'English',
58+
items: [
59+
{ text: '简体中文', link: 'https://cn.vitejs.dev' },
60+
{ text: '日本語', link: 'https://ja.vitejs.dev' }
61+
]
62+
},
63+
3164
nav: [
3265
{ text: 'Guide', link: '/guide/' },
3366
{ text: 'Config', link: '/config/' },
@@ -69,34 +102,14 @@ export default defineConfig({
69102
link: 'https://v2.vitejs.dev'
70103
}
71104
]
72-
},
73-
{
74-
text: 'Languages',
75-
items: [
76-
{
77-
text: 'English',
78-
link: 'https://vitejs.dev'
79-
},
80-
{
81-
text: '简体中文',
82-
link: 'https://cn.vitejs.dev'
83-
},
84-
{
85-
text: '日本語',
86-
link: 'https://ja.vitejs.dev'
87-
}
88-
]
89105
}
90106
],
91107

92108
sidebar: {
93-
'/config/': 'auto',
94-
'/plugins': 'auto',
95-
// catch-all fallback
96109
'/': [
97110
{
98111
text: 'Guide',
99-
children: [
112+
items: [
100113
{
101114
text: 'Why Vite',
102115
link: '/guide/why'
@@ -153,7 +166,7 @@ export default defineConfig({
153166
},
154167
{
155168
text: 'APIs',
156-
children: [
169+
items: [
157170
{
158171
text: 'Plugin API',
159172
link: '/guide/api-plugin'

docs/.vitepress/theme/index.js renamed to docs/.vitepress/theme/index.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
import Theme from 'vitepress/theme'
21
import { h } from 'vue'
2+
import Theme from 'vitepress/theme'
33
import SponsorsSidebar from './SponsorsSidebar.vue'
4-
import './custom.css'
4+
import './styles/vars.css'
5+
import './styles/custom.css'
56

67
export default {
78
...Theme,

docs/.vitepress/theme/custom.css renamed to docs/.vitepress/theme/styles/custom.css

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,12 @@
1616
display: none;
1717
}
1818

19-
:root {
20-
--c-brand: #646cff;
21-
--c-brand-light: #747bff;
22-
}
23-
2419
.custom-block.tip {
25-
border-color: var(--c-brand-light);
20+
border-color: var(--vp-c-brand-light);
2621
}
2722

2823
.DocSearch {
29-
--docsearch-primary-color: var(--c-brand) !important;
24+
--docsearch-primary-color: var(--vp-c-brand) !important;
3025
}
3126

3227
#play-vite-audio {

docs/.vitepress/theme/styles/vars.css

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
:root {
2+
--vp-c-brand: #646cff;
3+
--vp-c-brand-light: #747bff;
4+
--vp-c-brand-dark: #535bf2;
5+
}

docs/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ features:
2323
footer: MIT Licensed | Copyright © 2019-present Evan You & Vite Contributors
2424
---
2525

26+
> TODO: Home Page feature is not ready in VitePress Next just yet! So this page looks broken for now.
27+
2628
<script setup>
2729
import SponsorsGroup from './.vitepress/theme/SponsorsGroup.vue'
2830
</script>

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@
8383
"typescript": "^4.6.4",
8484
"unbuild": "^0.7.4",
8585
"vite": "workspace:*",
86-
"vitepress": "^0.22.4",
86+
"vitepress": "1.0.0-draft.1",
8787
"vitest": "^0.12.4",
8888
"vue": "^3.2.33"
8989
},

pnpm-lock.yaml

Lines changed: 62 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)