vitest/docs/.vitepress/config.ts

import { defineConfig } from 'vitepress'

export default defineConfig({
  title: 'Vitest',
  description: 'A blazing fast unit test framework powered by Vite',
  head: [
    ['meta', { property: 'og:title', content: 'Vitest' }],
    ['meta', { property: 'og:description', content: 'A blazing fast unit test framework powered by Vite' }],
    ['meta', { property: 'og:url', content: 'https://vitest.dev/' }],
    ['meta', { property: 'og:image', content: 'https://vitest.dev/og.png' }],
    ['meta', { name: 'twitter:title', content: 'Vitest' }],
    ['meta', { name: 'twitter:description', content: 'A blazing fast unit test framework powered by Vite' }],
    ['meta', { name: 'twitter:image', content: 'https://vitest.dev/og.png' }],
    ['meta', { name: 'twitter:card', content: 'summary_large_image' }],
    ['link', { rel: 'icon', href: '/logo.svg', type: 'image/svg+xml' }],
    ['link', { href: 'https://fonts.googleapis.com/css2?family=Readex+Pro:wght@200;400;600&display=swap', rel: 'stylesheet' }],
  ],
  themeConfig: {
    repo: 'vitest-dev/vitest',
    logo: '/logo.svg',
    docsDir: 'docs',
    docsBranch: 'main',
    editLinks: true,
    editLinkText: 'Suggest changes to this page',

    /* TODO

    algolia: {
      apiKey: '...',
      indexName: 'vitest',
      searchParameters: {
        facetFilters: ['tags:en']
      }
    },
    
    carbonAds: {
      carbon: '...',
      placement: 'vitest'
    },
    */

    nav: [
      { text: 'Guide', link: '/guide/' },
      { text: 'API', link: '/api/' },
      { text: 'Config', link: '/config/' },
      // { text: 'Plugins', link: '/plugins/' },
      {
        text: 'Discord',
        // TODO: 'https://chat.vitest.dev'
        link: 'https://chat.vitest.dev'
      },
      {
        text: 'Twitter',
        link: 'https://twitter.com/vitest_dev'
      },
      /* TODO
      {
        text: 'Languages',
        items: [
          {
            text: 'English',
            link: 'https://vitest.dev'
          },
          {
            text: '简体中文',
            link: 'https://cn.vitest.dev'
          },
          {
            text: '日本語',
            link: 'https://ja.vitest.dev'
          }
        ]
      }
      */
    ],

    sidebar: {
      '/config/': 'auto',
      '/api/': 'auto',
      // '/plugins': 'auto',
      // catch-all fallback
      '/': [
        {
          text: 'Guide',
          children: [
            {
              text: 'Why Vitest',
              link: '/guide/why'
            },
            {
              text: 'Getting Started',
              link: '/guide/'
            },
            {
              text: 'Features',
              link: '/guide/features'
            },
            {
              text: 'Mocking Functions',
              link: '/guide/mocking'
            },
            {
              text: 'Mocking Timers',
              link: '/guide/mocking-timers'
            },
            {
              text: 'Mocking Date',
              link: '/guide/mocking-date'
            },
            /* TODO
            {
              text: 'Using Plugins',
              link: '/guide/using-plugins'
            },
            */
            {
              text: 'Comparisons',
              link: '/guide/comparisons'
            }
          ]
        },
        /* TODO
        {
          text: 'APIs',
          children: [
            {
              text: 'Plugin API',
              link: '/guide/api-plugin'
            },
            {
              text: 'Config Reference',
              link: '/config/'
            }
          ]
        },
        */
      ]
    }
  }
})