Skip to content

Commit 54c3dc8

Browse files
docs: update the website application (#2171)
* chore: transform `.vitepress/config.ts` into a config folder also, use it to separate and gather up all languages settings * chore: resolve the conflits over the vitest versions * chore: update `.gitignore` to ignore `.vitepress/cache` * chore: update `docs/index.md` structure * chore: update `docs/fr/index.md` structure * chore: delete `docs/fr/.vitepress/locale-config.ts` because it was moved to `docs/.vitepress/config/fr.ts` * chore: remove `headconfig` from `.vitepress/config/shared.ts` * chore: update `pnpm-lock.yaml` * chore: update `.gitignore` * chore: update `netlify.toml` to set the publish folder * chore: add `public/logo.svg` * chore: update `docs/index.md` and `docs/fr/index.md` * chore: update `pnpm-lock-yaml` * chore: set website appearence to be based on user preference
1 parent b5dde9f commit 54c3dc8

File tree

13 files changed

+706
-711
lines changed

13 files changed

+706
-711
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22
node_modules
33
dist
44
coverage
5+
docs/.vitepress/cache

docs/.vitepress/config.ts

Lines changed: 0 additions & 235 deletions
This file was deleted.

docs/.vitepress/config/en.ts

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
import type { DefaultTheme, LocalSpecificConfig } from 'vitepress'
2+
3+
export const META_URL = ''
4+
export const META_TITLE = 'Vue Test Utils'
5+
export const META_DESCRIPTION = 'The official testing suite utils for Vue.js 3'
6+
7+
export const enConfig: LocalSpecificConfig<DefaultTheme.config> = {
8+
description: META_DESCRIPTION,
9+
head: [
10+
['meta', { property: 'og:url', content: META_URL }],
11+
['meta', { property: 'og:title', content: META_TITLE }],
12+
['meta', { property: 'og:description', content: META_DESCRIPTION }],
13+
['meta', { property: 'twitter:url', content: META_URL }],
14+
['meta', { property: 'twitter:title', content: META_TITLE }],
15+
['meta', { property: 'twitter:description', content: META_DESCRIPTION }],
16+
],
17+
18+
themeConfig: {
19+
editLink: {
20+
pattern: 'https://github.com/vuejs/test-utils/edit/main/docs/:path',
21+
text: 'Suggest changes to this page',
22+
},
23+
24+
nav: [
25+
{ text: 'Guide', link: '/guide/' },
26+
{ text: 'API Reference', link: '/api/' },
27+
{ text: 'Migrating from Vue 2', link: '/migration/' },
28+
{
29+
text: 'Changelog',
30+
link: 'https://github.com/vuejs/test-utils/releases'
31+
}
32+
],
33+
34+
sidebar: {
35+
'/': [
36+
{
37+
text: 'Installation',
38+
link: '/installation/'
39+
},
40+
{
41+
text: 'Essentials',
42+
collapsable: false,
43+
items: [
44+
{ text: 'Getting Started', link: '/guide/' },
45+
{ text: 'A Crash Course', link: '/guide/essentials/a-crash-course' },
46+
{
47+
text: 'Conditional Rendering',
48+
link: '/guide/essentials/conditional-rendering'
49+
},
50+
{
51+
text: 'Testing Emitted Events',
52+
link: '/guide/essentials/event-handling'
53+
},
54+
{ text: 'Testing Forms', link: '/guide/essentials/forms' },
55+
{
56+
text: 'Passing Data to Components',
57+
link: '/guide/essentials/passing-data'
58+
},
59+
{
60+
text: 'Write components that are easy to test',
61+
link: '/guide/essentials/easy-to-test'
62+
}
63+
]
64+
},
65+
{
66+
text: 'Vue Test Utils in depth',
67+
collapsable: false,
68+
items: [
69+
{ text: 'Slots', link: '/guide/advanced/slots' },
70+
{
71+
text: 'Asynchronous Behavior',
72+
link: '/guide/advanced/async-suspense'
73+
},
74+
{
75+
text: 'Making HTTP Requests',
76+
link: '/guide/advanced/http-requests'
77+
},
78+
{ text: 'Transitions', link: '/guide/advanced/transitions' },
79+
{
80+
text: 'Component Instance',
81+
link: '/guide/advanced/component-instance'
82+
},
83+
{
84+
text: 'Reusability and Composition',
85+
link: '/guide/advanced/reusability-composition'
86+
},
87+
{ text: 'Testing v-model', link: '/guide/advanced/v-model' },
88+
{ text: 'Testing Vuex', link: '/guide/advanced/vuex' },
89+
{ text: 'Testing Vue Router', link: '/guide/advanced/vue-router' },
90+
{ text: 'Testing Teleport', link: '/guide/advanced/teleport' },
91+
{
92+
text: 'Stubs and Shallow Mount',
93+
link: '/guide/advanced/stubs-shallow-mount'
94+
},
95+
{ text: 'Testing Server-side Rendering', link: '/guide/advanced/ssr' }
96+
]
97+
},
98+
{
99+
text: 'Extending Vue Test Utils',
100+
collapsable: false,
101+
items: [
102+
{ text: 'Plugins', link: '/guide/extending-vtu/plugins' },
103+
{
104+
text: 'Community and Learning',
105+
link: '/guide/extending-vtu/community-learning'
106+
}
107+
]
108+
},
109+
{
110+
text: 'FAQ',
111+
link: '/guide/faq/'
112+
},
113+
{
114+
text: 'Migrating from Vue 2',
115+
link: '/migration/'
116+
},
117+
{
118+
text: 'API Reference',
119+
link: '/api/'
120+
}
121+
]
122+
}
123+
}
124+
}

0 commit comments

Comments
 (0)