Skip to content

Commit

Permalink
docs: update the website application (#2171)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
nazarepiedady committed Aug 28, 2023
1 parent b5dde9f commit 54c3dc8
Show file tree
Hide file tree
Showing 13 changed files with 706 additions and 711 deletions.
1 change: 1 addition & 0 deletions .gitignore
Expand Up @@ -2,3 +2,4 @@
node_modules
dist
coverage
docs/.vitepress/cache
235 changes: 0 additions & 235 deletions docs/.vitepress/config.ts

This file was deleted.

124 changes: 124 additions & 0 deletions docs/.vitepress/config/en.ts
@@ -0,0 +1,124 @@
import type { DefaultTheme, LocalSpecificConfig } from 'vitepress'

export const META_URL = ''
export const META_TITLE = 'Vue Test Utils'
export const META_DESCRIPTION = 'The official testing suite utils for Vue.js 3'

export const enConfig: LocalSpecificConfig<DefaultTheme.config> = {
description: META_DESCRIPTION,
head: [
['meta', { property: 'og:url', content: META_URL }],
['meta', { property: 'og:title', content: META_TITLE }],
['meta', { property: 'og:description', content: META_DESCRIPTION }],
['meta', { property: 'twitter:url', content: META_URL }],
['meta', { property: 'twitter:title', content: META_TITLE }],
['meta', { property: 'twitter:description', content: META_DESCRIPTION }],
],

themeConfig: {
editLink: {
pattern: 'https://github.com/vuejs/test-utils/edit/main/docs/:path',
text: 'Suggest changes to this page',
},

nav: [
{ text: 'Guide', link: '/guide/' },
{ text: 'API Reference', link: '/api/' },
{ text: 'Migrating from Vue 2', link: '/migration/' },
{
text: 'Changelog',
link: 'https://github.com/vuejs/test-utils/releases'
}
],

sidebar: {
'/': [
{
text: 'Installation',
link: '/installation/'
},
{
text: 'Essentials',
collapsable: false,
items: [
{ text: 'Getting Started', link: '/guide/' },
{ text: 'A Crash Course', link: '/guide/essentials/a-crash-course' },
{
text: 'Conditional Rendering',
link: '/guide/essentials/conditional-rendering'
},
{
text: 'Testing Emitted Events',
link: '/guide/essentials/event-handling'
},
{ text: 'Testing Forms', link: '/guide/essentials/forms' },
{
text: 'Passing Data to Components',
link: '/guide/essentials/passing-data'
},
{
text: 'Write components that are easy to test',
link: '/guide/essentials/easy-to-test'
}
]
},
{
text: 'Vue Test Utils in depth',
collapsable: false,
items: [
{ text: 'Slots', link: '/guide/advanced/slots' },
{
text: 'Asynchronous Behavior',
link: '/guide/advanced/async-suspense'
},
{
text: 'Making HTTP Requests',
link: '/guide/advanced/http-requests'
},
{ text: 'Transitions', link: '/guide/advanced/transitions' },
{
text: 'Component Instance',
link: '/guide/advanced/component-instance'
},
{
text: 'Reusability and Composition',
link: '/guide/advanced/reusability-composition'
},
{ text: 'Testing v-model', link: '/guide/advanced/v-model' },
{ text: 'Testing Vuex', link: '/guide/advanced/vuex' },
{ text: 'Testing Vue Router', link: '/guide/advanced/vue-router' },
{ text: 'Testing Teleport', link: '/guide/advanced/teleport' },
{
text: 'Stubs and Shallow Mount',
link: '/guide/advanced/stubs-shallow-mount'
},
{ text: 'Testing Server-side Rendering', link: '/guide/advanced/ssr' }
]
},
{
text: 'Extending Vue Test Utils',
collapsable: false,
items: [
{ text: 'Plugins', link: '/guide/extending-vtu/plugins' },
{
text: 'Community and Learning',
link: '/guide/extending-vtu/community-learning'
}
]
},
{
text: 'FAQ',
link: '/guide/faq/'
},
{
text: 'Migrating from Vue 2',
link: '/migration/'
},
{
text: 'API Reference',
link: '/api/'
}
]
}
}
}

0 comments on commit 54c3dc8

Please sign in to comment.