From 84e85b25184f7628de97a33b32e1384a70351830 Mon Sep 17 00:00:00 2001
From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Date: Fri, 9 Sep 2022 10:21:37 +0530
Subject: [PATCH 01/24] merge feat-i18n

fix: don't break when locales are not used
fix: make navbar title link to current locale
feat: allow customizing locale link in navbar
feat: allow overriding theme config
feat: support overriding head based on current locale
feat: support customizing title and description
feat: add lang attribute to html based on route
feat: show current and available langs on navbar
fix: refactor types to support locales
fix: group label customization to theme.translations
---
 src/client/app/data.ts                        |  18 +--
 src/client/app/utils.ts                       |   2 +-
 src/client/index.ts                           |   3 +-
 .../components/VPAlgoliaSearchBox.vue         |   8 +-
 .../theme-default/components/VPCarbonAds.vue  |   9 +-
 .../theme-default/components/VPDocAside.vue   |   2 +-
 .../components/VPDocAsideCarbonAds.vue        |   7 +-
 .../components/VPDocAsideOutline.vue          |   2 +-
 .../theme-default/components/VPDocFooter.vue  |   4 +-
 .../components/VPDocFooterLastUpdated.vue     |   2 +-
 .../theme-default/components/VPLocalNav.vue   |   8 +-
 .../components/VPNavBarExtra.vue              |  12 +-
 .../components/VPNavBarSearch.vue             |   2 +-
 .../components/VPNavBarTitle.vue              |   7 +-
 .../components/VPNavBarTranslations.vue       |  10 +-
 .../components/VPNavScreenAppearance.vue      |   6 +-
 .../components/VPNavScreenTranslations.vue    |  15 +-
 .../theme-default/composables/edit-link.ts    |   2 +-
 src/client/theme-default/composables/langs.ts |  32 +++++
 src/client/theme-default/composables/nav.ts   |  36 +----
 src/client/theme-default/support/sidebar.ts   |   2 +-
 src/client/theme-default/support/utils.ts     |  45 +-----
 src/node/build/render.ts                      |   5 +-
 src/node/config.ts                            |  38 +++--
 src/node/index.ts                             |   1 -
 src/node/markdown/markdown.ts                 |   5 +-
 src/shared/shared.ts                          | 131 ++++++++----------
 types/default-theme.d.ts                      |  97 ++++++-------
 types/shared.d.ts                             |  51 ++-----
 29 files changed, 243 insertions(+), 319 deletions(-)
 create mode 100644 src/client/theme-default/composables/langs.ts

diff --git a/src/client/app/data.ts b/src/client/app/data.ts
index 22dc314194ef..3d9508090c68 100644
--- a/src/client/app/data.ts
+++ b/src/client/app/data.ts
@@ -5,9 +5,9 @@ import {
   PageData,
   SiteData,
   resolveSiteDataByRoute,
-  createTitle
+  createTitle,
+  DefaultTheme
 } from '../shared.js'
-import { withBase } from './utils.js'
 
 export const dataSymbol: InjectionKey<VitePressData> = Symbol()
 
@@ -19,7 +19,7 @@ export interface VitePressData<T = any> {
   title: Ref<string>
   description: Ref<string>
   lang: Ref<string>
-  localePath: Ref<string>
+  localeIndex: Ref<string>
 }
 
 // site data is a singleton
@@ -39,7 +39,7 @@ if (import.meta.hot) {
 // per-app data
 export function initData(route: Route): VitePressData {
   const site = computed(() =>
-    resolveSiteDataByRoute(siteDataRef.value, route.path)
+    resolveSiteDataByRoute(siteDataRef.value, route.data.relativePath)
   )
 
   return {
@@ -48,13 +48,7 @@ export function initData(route: Route): VitePressData {
     page: computed(() => route.data),
     frontmatter: computed(() => route.data.frontmatter),
     lang: computed(() => site.value.lang),
-    localePath: computed(() => {
-      const { langs, lang } = site.value
-      const path = Object.keys(langs).find(
-        (langPath) => langs[langPath].lang === lang
-      )
-      return withBase(path || '/')
-    }),
+    localeIndex: computed(() => site.value.localeIndex || 'root'),
     title: computed(() => {
       return createTitle(site.value, route.data)
     }),
@@ -64,7 +58,7 @@ export function initData(route: Route): VitePressData {
   }
 }
 
-export function useData<T = any>(): VitePressData<T> {
+export function useData<T = DefaultTheme.Config>(): VitePressData<T> {
   const data = inject(dataSymbol)
   if (!data) {
     throw new Error('vitepress data not properly injected in app')
diff --git a/src/client/app/utils.ts b/src/client/app/utils.ts
index 2bc3f28b14f9..2f8be606544a 100644
--- a/src/client/app/utils.ts
+++ b/src/client/app/utils.ts
@@ -1,7 +1,7 @@
 import { siteDataRef } from './data.js'
 import { inBrowser, EXTERNAL_URL_RE } from '../shared.js'
 
-export { inBrowser }
+export { inBrowser } from '../shared.js'
 
 /**
  * Join two paths by resolving the slash collision.
diff --git a/src/client/index.ts b/src/client/index.ts
index 4d56c9ea3b94..1ed560d902a1 100644
--- a/src/client/index.ts
+++ b/src/client/index.ts
@@ -11,8 +11,7 @@ export type {
   PageData,
   SiteData,
   HeadConfig,
-  Header,
-  LocaleConfig
+  Header
 } from '../../types/shared.js'
 
 // composables
diff --git a/src/client/theme-default/components/VPAlgoliaSearchBox.vue b/src/client/theme-default/components/VPAlgoliaSearchBox.vue
index dce2916aee2e..08822b931156 100644
--- a/src/client/theme-default/components/VPAlgoliaSearchBox.vue
+++ b/src/client/theme-default/components/VPAlgoliaSearchBox.vue
@@ -4,12 +4,16 @@ import { default as docsearch } from '@docsearch/js'
 import { onMounted } from 'vue'
 import { useRouter, useRoute, useData } from 'vitepress'
 
+const props = defineProps<{
+  algolia: DefaultTheme.AlgoliaSearchOptions
+}>()
+
 const router = useRouter()
 const route = useRoute()
-const { theme, site } = useData()
+const { site } = useData()
 
 onMounted(() => {
-  initialize(theme.value.algolia)
+  initialize(props.algolia)
   setTimeout(poll, 16)
 })
 
diff --git a/src/client/theme-default/components/VPCarbonAds.vue b/src/client/theme-default/components/VPCarbonAds.vue
index d1f669f18fd2..4da1508d43db 100644
--- a/src/client/theme-default/components/VPCarbonAds.vue
+++ b/src/client/theme-default/components/VPCarbonAds.vue
@@ -1,10 +1,13 @@
 <script setup lang="ts">
+import type { DefaultTheme } from 'vitepress/theme'
 import { ref, watch, onMounted } from 'vue'
-import { useData } from 'vitepress'
 import { useAside } from '../composables/aside.js'
 
-const { theme } = useData()
-const carbonOptions = theme.value.carbonAds
+const props = defineProps<{
+  carbonAds: DefaultTheme.CarbonAdsOptions
+}>()
+
+const carbonOptions = props.carbonAds
 const { isAsideEnabled } = useAside()
 const container = ref()
 
diff --git a/src/client/theme-default/components/VPDocAside.vue b/src/client/theme-default/components/VPDocAside.vue
index f434ce55fd7b..ab7084276eab 100644
--- a/src/client/theme-default/components/VPDocAside.vue
+++ b/src/client/theme-default/components/VPDocAside.vue
@@ -17,7 +17,7 @@ const { theme } = useData()
     <div class="spacer" />
 
     <slot name="aside-ads-before" />
-    <VPDocAsideCarbonAds v-if="theme.carbonAds" />
+    <VPDocAsideCarbonAds v-if="theme.carbonAds" :carbonAds="theme.carbonAds" />
     <slot name="aside-ads-after" />
 
     <slot name="aside-bottom" />
diff --git a/src/client/theme-default/components/VPDocAsideCarbonAds.vue b/src/client/theme-default/components/VPDocAsideCarbonAds.vue
index c5e9f1ddbcd8..9d56016f6572 100644
--- a/src/client/theme-default/components/VPDocAsideCarbonAds.vue
+++ b/src/client/theme-default/components/VPDocAsideCarbonAds.vue
@@ -1,6 +1,11 @@
 <script setup lang="ts">
+import type { DefaultTheme } from 'vitepress/theme'
 import { defineAsyncComponent } from 'vue'
 
+const props = defineProps<{
+  carbonAds: DefaultTheme.CarbonAdsOptions
+}>()
+
 const VPCarbonAds = __CARBON__
   ? defineAsyncComponent(() => import('./VPCarbonAds.vue'))
   : () => null
@@ -8,6 +13,6 @@ const VPCarbonAds = __CARBON__
 
 <template>
   <div class="VPDocAsideCarbonAds">
-    <VPCarbonAds />
+    <VPCarbonAds :carbonAds="props" />
   </div>
 </template>
diff --git a/src/client/theme-default/components/VPDocAsideOutline.vue b/src/client/theme-default/components/VPDocAsideOutline.vue
index c8160cca43d7..cd8e8f91416a 100644
--- a/src/client/theme-default/components/VPDocAsideOutline.vue
+++ b/src/client/theme-default/components/VPDocAsideOutline.vue
@@ -43,7 +43,7 @@ function handleClick({ target: el }: Event) {
       <div class="outline-marker" ref="marker" />
 
       <div class="outline-title">
-        {{ theme.outlineTitle || 'On this page' }}
+        {{ theme.translations?.outlineTitle || 'On this page' }}
       </div>
 
       <nav aria-labelledby="doc-outline-aria-label">
diff --git a/src/client/theme-default/components/VPDocFooter.vue b/src/client/theme-default/components/VPDocFooter.vue
index 31adc7842b59..5441a3e757ab 100644
--- a/src/client/theme-default/components/VPDocFooter.vue
+++ b/src/client/theme-default/components/VPDocFooter.vue
@@ -42,13 +42,13 @@ const showFooter = computed(() => {
     <div v-if="control.prev || control.next" class="prev-next">
       <div class="pager">
         <a v-if="control.prev" class="pager-link prev" :href="normalizeLink(control.prev.link)">
-          <span class="desc">{{ theme.docFooter?.prev ?? 'Previous page' }}</span>
+          <span class="desc">{{ theme.translations?.docFooter?.prev || 'Previous page' }}</span>
           <span class="title">{{ control.prev.text }} </span>
         </a>
       </div>
       <div class="pager" :class="{ 'has-prev': control.prev }">
         <a v-if="control.next" class="pager-link next" :href="normalizeLink(control.next.link)">
-          <span class="desc">{{ theme.docFooter?.next ?? 'Next page' }}</span>
+          <span class="desc">{{ theme.translations?.docFooter?.next || 'Next page' }}</span>
           <span class="title">{{ control.next.text }}</span>
         </a>
       </div>
diff --git a/src/client/theme-default/components/VPDocFooterLastUpdated.vue b/src/client/theme-default/components/VPDocFooterLastUpdated.vue
index 6843785ca119..1ac29682bb9f 100644
--- a/src/client/theme-default/components/VPDocFooterLastUpdated.vue
+++ b/src/client/theme-default/components/VPDocFooterLastUpdated.vue
@@ -20,7 +20,7 @@ onMounted(() => {
 
 <template>
   <p class="VPLastUpdated">
-    {{ theme.lastUpdatedText ?? 'Last updated' }}:
+    {{ theme.translations?.lastUpdatedText || 'Last updated' }}:
     <time :datatime="isoDatetime">{{ datetime }}</time>
   </p>
 </template>
diff --git a/src/client/theme-default/components/VPLocalNav.vue b/src/client/theme-default/components/VPLocalNav.vue
index 29d323f33801..4833a5ee2840 100644
--- a/src/client/theme-default/components/VPLocalNav.vue
+++ b/src/client/theme-default/components/VPLocalNav.vue
@@ -1,4 +1,5 @@
 <script lang="ts" setup>
+import { useData } from 'vitepress'
 import { useSidebar } from '../composables/sidebar.js'
 import VPIconAlignLeft from './icons/VPIconAlignLeft.vue'
 
@@ -10,6 +11,7 @@ defineEmits<{
   (e: 'open-menu'): void
 }>()
 
+const { theme } = useData()
 const { hasSidebar } = useSidebar()
 
 function scrollToTop() {
@@ -26,11 +28,13 @@ function scrollToTop() {
       @click="$emit('open-menu')"
     >
       <VPIconAlignLeft class="menu-icon" />
-      <span class="menu-text">Menu</span>
+      <span class="menu-text">
+        {{ theme.translations?.sidebarMenuLabel || 'Menu' }}
+      </span>
     </button>
 
     <a class="top-link" href="#" @click="scrollToTop">
-      Return to top
+      {{ theme.translations?.returnToTopLabel || 'Return to top' }}
     </a>
   </div>
 </template>
diff --git a/src/client/theme-default/components/VPNavBarExtra.vue b/src/client/theme-default/components/VPNavBarExtra.vue
index aceca5ce6b9b..93efc2179757 100644
--- a/src/client/theme-default/components/VPNavBarExtra.vue
+++ b/src/client/theme-default/components/VPNavBarExtra.vue
@@ -4,23 +4,27 @@ import VPFlyout from './VPFlyout.vue'
 import VPMenuLink from './VPMenuLink.vue'
 import VPSwitchAppearance from './VPSwitchAppearance.vue'
 import VPSocialLinks from './VPSocialLinks.vue'
+import { useLangs } from '../composables/langs.js'
 
 const { site, theme } = useData()
+const { localeLinks, currentLang } = useLangs()
 </script>
 
 <template>
   <VPFlyout class="VPNavBarExtra" label="extra navigation">
-    <div v-if="theme.localeLinks" class="group">
-      <p class="trans-title">{{ theme.localeLinks.text }}</p>
+    <div v-if="localeLinks.length && currentLang.label" class="group">
+      <p class="trans-title">{{ currentLang.label }}</p>
 
-      <template v-for="locale in theme.localeLinks.items" :key="locale.link">
+      <template v-for="locale in localeLinks" :key="locale.link">
         <VPMenuLink :item="locale" />
       </template>
     </div>
 
     <div v-if="site.appearance" class="group">
       <div class="item appearance">
-        <p class="label">Appearance</p>
+        <p class="label">
+          {{ theme.translations?.darkModeSwitchLabel || 'Appearance' }}
+        </p>
         <div class="appearance-action">
           <VPSwitchAppearance />
         </div>
diff --git a/src/client/theme-default/components/VPNavBarSearch.vue b/src/client/theme-default/components/VPNavBarSearch.vue
index e29075492b70..5ab51a87ebe8 100644
--- a/src/client/theme-default/components/VPNavBarSearch.vue
+++ b/src/client/theme-default/components/VPNavBarSearch.vue
@@ -52,7 +52,7 @@ function load() {
 
 <template>
   <div v-if="theme.algolia" class="VPNavBarSearch">
-    <VPAlgoliaSearchBox v-if="loaded" />
+    <VPAlgoliaSearchBox v-if="loaded" :algolia="theme.algolia" />
 
     <div v-else id="docsearch" @click="load">
       <button
diff --git a/src/client/theme-default/components/VPNavBarTitle.vue b/src/client/theme-default/components/VPNavBarTitle.vue
index 4e8ea1f6b621..89c2d9468552 100644
--- a/src/client/theme-default/components/VPNavBarTitle.vue
+++ b/src/client/theme-default/components/VPNavBarTitle.vue
@@ -1,17 +1,20 @@
 <script setup lang="ts">
 import { useData } from 'vitepress'
 import { useSidebar } from '../composables/sidebar.js'
+import { useLangs } from '../composables/langs.js'
+import { normalizeLink } from '../support/utils.js'
 import VPImage from './VPImage.vue'
 
 const { site, theme } = useData()
 const { hasSidebar } = useSidebar()
+const { currentLang } = useLangs()
 </script>
 
 <template>
   <div class="VPNavBarTitle" :class="{ 'has-sidebar': hasSidebar }">
-    <a class="title" :href="site.base">
+    <a class="title" :href="normalizeLink(currentLang.link)">
       <slot name="nav-bar-title-before" />
-      <VPImage class="logo" :image="theme.logo" />
+      <VPImage v-if="theme.logo" class="logo" :image="theme.logo" />
       <template v-if="theme.siteTitle">{{ theme.siteTitle }}</template>
       <template v-else-if="theme.siteTitle === undefined">{{ site.title }}</template>
       <slot name="nav-bar-title-after" />
diff --git a/src/client/theme-default/components/VPNavBarTranslations.vue b/src/client/theme-default/components/VPNavBarTranslations.vue
index fe91597b0a6e..d271a8cc6ed6 100644
--- a/src/client/theme-default/components/VPNavBarTranslations.vue
+++ b/src/client/theme-default/components/VPNavBarTranslations.vue
@@ -1,22 +1,22 @@
 <script lang="ts" setup>
-import { useData } from 'vitepress'
 import VPIconLanguages from './icons/VPIconLanguages.vue'
 import VPFlyout from './VPFlyout.vue'
 import VPMenuLink from './VPMenuLink.vue'
+import { useLangs } from '../composables/langs.js'
 
-const { theme } = useData()
+const { localeLinks, currentLang } = useLangs()
 </script>
 
 <template>
   <VPFlyout
-    v-if="theme.localeLinks"
+    v-if="localeLinks.length && currentLang.label"
     class="VPNavBarTranslations"
     :icon="VPIconLanguages"
   >
     <div class="items">
-      <p class="title">{{ theme.localeLinks.text }}</p>
+      <p class="title">{{ currentLang.label }}</p>
 
-      <template v-for="locale in theme.localeLinks.items" :key="locale.link">
+      <template v-for="locale in localeLinks" :key="locale.link">
         <VPMenuLink :item="locale" />
       </template>
     </div>
diff --git a/src/client/theme-default/components/VPNavScreenAppearance.vue b/src/client/theme-default/components/VPNavScreenAppearance.vue
index 3a804195cabd..87bbcb4d05de 100644
--- a/src/client/theme-default/components/VPNavScreenAppearance.vue
+++ b/src/client/theme-default/components/VPNavScreenAppearance.vue
@@ -2,12 +2,14 @@
 import { useData } from 'vitepress'
 import VPSwitchAppearance from './VPSwitchAppearance.vue'
 
-const { site } = useData()
+const { site, theme } = useData()
 </script>
 
 <template>
   <div v-if="site.appearance" class="VPNavScreenAppearance">
-    <p class="text">Appearance</p>
+    <p class="text">
+      {{ theme.translations?.darkModeSwitchLabel || 'Appearance' }}
+    </p>
     <VPSwitchAppearance />
   </div>
 </template>
diff --git a/src/client/theme-default/components/VPNavScreenTranslations.vue b/src/client/theme-default/components/VPNavScreenTranslations.vue
index 7305554ed0ce..68b0388aef3e 100644
--- a/src/client/theme-default/components/VPNavScreenTranslations.vue
+++ b/src/client/theme-default/components/VPNavScreenTranslations.vue
@@ -1,11 +1,10 @@
 <script setup lang="ts">
 import { ref } from 'vue'
-import { useData } from 'vitepress'
 import VPIconChevronDown from './icons/VPIconChevronDown.vue'
 import VPIconLanguages from './icons/VPIconLanguages.vue'
+import { useLangs } from '../composables/langs.js'
 
-const { theme } = useData()
-
+const { localeLinks, currentLang } = useLangs()
 const isOpen = ref(false)
 
 function toggle() {
@@ -14,15 +13,19 @@ function toggle() {
 </script>
 
 <template>
-  <div v-if="theme.localeLinks" class="VPNavScreenTranslations" :class="{ open: isOpen }">
+  <div
+    v-if="localeLinks.length && currentLang.label"
+    class="VPNavScreenTranslations"
+    :class="{ open: isOpen }"
+  >
     <button class="title" @click="toggle">
       <VPIconLanguages class="icon lang" />
-      {{ theme.localeLinks.text }}
+      {{ currentLang.label }}
       <VPIconChevronDown class="icon chevron" />
     </button>
 
     <ul class="list">
-      <li v-for="locale in theme.localeLinks.items" :key="locale.link" class="item">
+      <li v-for="locale in localeLinks" :key="locale.link" class="item">
         <a class="link" :href="locale.link">{{ locale.text }}</a>
       </li>
     </ul>
diff --git a/src/client/theme-default/composables/edit-link.ts b/src/client/theme-default/composables/edit-link.ts
index e8a6a156e252..0e76b8931b04 100644
--- a/src/client/theme-default/composables/edit-link.ts
+++ b/src/client/theme-default/composables/edit-link.ts
@@ -5,7 +5,7 @@ export function useEditLink() {
   const { theme, page } = useData()
 
   return computed(() => {
-    const { text = 'Edit this page', pattern } = theme.value.editLink || {}
+    const { text = 'Edit this page', pattern = '' } = theme.value.editLink || {}
     const { relativePath } = page.value
     const url = pattern.replace(/:path/g, relativePath)
 
diff --git a/src/client/theme-default/composables/langs.ts b/src/client/theme-default/composables/langs.ts
new file mode 100644
index 000000000000..b79c17e72cbf
--- /dev/null
+++ b/src/client/theme-default/composables/langs.ts
@@ -0,0 +1,32 @@
+import { computed } from 'vue'
+import { useData } from 'vitepress'
+import { isExternal } from '../support/utils.js'
+
+export function useLangs() {
+  const { site, localeIndex } = useData()
+  const currentLang = computed(() => ({
+    label: site.value.locales[localeIndex.value]?.label,
+    link:
+      localeIndex.value === 'root'
+        ? '/'
+        : site.value.locales[localeIndex.value].link || `/${localeIndex.value}/`
+  }))
+
+  const localeLinks = computed(() =>
+    Object.entries(site.value.locales).flatMap(([key, value]) =>
+      currentLang.value.label === value.label
+        ? []
+        : {
+            text: value.label,
+            link:
+              key === 'root'
+                ? '/'
+                : isExternal(key)
+                ? key
+                : value.link || `/${key}/`
+          }
+    )
+  )
+
+  return { localeLinks, currentLang }
+}
diff --git a/src/client/theme-default/composables/nav.ts b/src/client/theme-default/composables/nav.ts
index e3cf686b4552..92413b5a9f74 100644
--- a/src/client/theme-default/composables/nav.ts
+++ b/src/client/theme-default/composables/nav.ts
@@ -1,6 +1,5 @@
-import type { DefaultTheme } from 'vitepress/theme'
-import { ref, computed, watch } from 'vue'
-import { useData, useRoute } from 'vitepress'
+import { ref, watch } from 'vue'
+import { useRoute } from 'vitepress'
 
 export function useNav() {
   const isScreenOpen = ref(false)
@@ -36,34 +35,3 @@ export function useNav() {
     toggleScreen
   }
 }
-
-export function useLanguageLinks() {
-  const { site, localePath, theme } = useData()
-
-  return computed(() => {
-    const langs = site.value.langs
-    const localePaths = Object.keys(langs)
-
-    // one language
-    if (localePaths.length < 2) {
-      return null
-    }
-
-    const route = useRoute()
-
-    // intentionally remove the leading slash because each locale has one
-    const currentPath = route.path.replace(localePath.value, '')
-
-    const candidates = localePaths.map((localePath) => ({
-      text: langs[localePath].label,
-      link: `${localePath}${currentPath}`
-    }))
-
-    const selectText = theme.value.selectText || 'Languages'
-
-    return {
-      text: selectText,
-      items: candidates
-    } as DefaultTheme.NavItemWithChildren
-  })
-}
diff --git a/src/client/theme-default/support/sidebar.ts b/src/client/theme-default/support/sidebar.ts
index b55fa1356f23..b00eaa021606 100644
--- a/src/client/theme-default/support/sidebar.ts
+++ b/src/client/theme-default/support/sidebar.ts
@@ -8,7 +8,7 @@ import { ensureStartingSlash } from './utils.js'
  * return empty array.
  */
 export function getSidebar(
-  sidebar: DefaultTheme.Sidebar,
+  sidebar: DefaultTheme.Sidebar | undefined,
   path: string
 ): DefaultTheme.SidebarGroup[] {
   if (Array.isArray(sidebar)) {
diff --git a/src/client/theme-default/support/utils.ts b/src/client/theme-default/support/utils.ts
index 33bc0bb539ca..3056cb973aa3 100644
--- a/src/client/theme-default/support/utils.ts
+++ b/src/client/theme-default/support/utils.ts
@@ -1,16 +1,7 @@
-import { ref } from 'vue'
 import { withBase, useData } from 'vitepress'
-import { EXTERNAL_URL_RE } from '../../shared.js'
+import { isExternal } from '../../shared.js'
 
-export const HASH_RE = /#.*$/
-export const EXT_RE = /(index)?\.(md|html)$/
-
-const inBrowser = typeof window !== 'undefined'
-const hashRef = ref(inBrowser ? location.hash : '')
-
-export function isExternal(path: string): boolean {
-  return EXTERNAL_URL_RE.test(path)
-}
+export { isExternal, isActive } from '../../shared.js'
 
 export function throttleAndDebounce(fn: () => void, delay: number): () => void {
   let timeoutId: NodeJS.Timeout
@@ -33,42 +24,10 @@ export function throttleAndDebounce(fn: () => void, delay: number): () => void {
   }
 }
 
-export function isActive(
-  currentPath: string,
-  matchPath?: string,
-  asRegex: boolean = false
-): boolean {
-  if (matchPath === undefined) {
-    return false
-  }
-
-  currentPath = normalize(`/${currentPath}`)
-
-  if (asRegex) {
-    return new RegExp(matchPath).test(currentPath)
-  }
-
-  if (normalize(matchPath) !== currentPath) {
-    return false
-  }
-
-  const hashMatch = matchPath.match(HASH_RE)
-
-  if (hashMatch) {
-    return hashRef.value === hashMatch[0]
-  }
-
-  return true
-}
-
 export function ensureStartingSlash(path: string): string {
   return /^\//.test(path) ? path : `/${path}`
 }
 
-export function normalize(path: string): string {
-  return decodeURI(path).replace(HASH_RE, '').replace(EXT_RE, '')
-}
-
 export function normalizeLink(url: string): string {
   if (isExternal(url)) {
     return url
diff --git a/src/node/build/render.ts b/src/node/build/render.ts
index 55e1adf3772e..87fb662a3fd5 100644
--- a/src/node/build/render.ts
+++ b/src/node/build/render.ts
@@ -10,10 +10,11 @@ import {
   createTitle,
   notFoundPageData,
   mergeHead,
-  EXTERNAL_URL_RE
+  EXTERNAL_URL_RE,
+  resolveSiteDataByRoute
 } from '../shared'
 import { slash } from '../utils/slash'
-import { SiteConfig, resolveSiteDataByRoute } from '../config'
+import { SiteConfig } from '../config'
 
 export async function renderPage(
   render: (path: string) => Promise<string>,
diff --git a/src/node/config.ts b/src/node/config.ts
index 11849089d06a..bc1500564014 100644
--- a/src/node/config.ts
+++ b/src/node/config.ts
@@ -13,9 +13,9 @@ import {
   SiteData,
   HeadConfig,
   LocaleConfig,
+  LocaleSpecificConfig,
   DefaultTheme,
   APPEARANCE_KEY,
-  createLangDictionary,
   CleanUrlsMode,
   PageData,
   Awaitable
@@ -24,23 +24,27 @@ import { DEFAULT_THEME_PATH } from './alias'
 import { MarkdownOptions } from './markdown/markdown'
 import _debug from 'debug'
 
-export { resolveSiteDataByRoute } from './shared'
-
 const debug = _debug('vitepress:config')
 
-export interface UserConfig<ThemeConfig = any> {
+export interface UserConfig<ThemeConfig = any>
+  extends LocaleSpecificConfig<ThemeConfig> {
   extends?: RawConfigExports<ThemeConfig>
+
   base?: string
-  lang?: string
-  title?: string
-  titleTemplate?: string | boolean
-  description?: string
-  head?: HeadConfig[]
+  srcDir?: string
+  srcExclude?: string[]
+  outDir?: string
+  shouldPreload?: (link: string, page: string) => boolean
+
+  locales?: LocaleConfig<ThemeConfig>
+
   appearance?: boolean
-  themeConfig?: ThemeConfig
-  locales?: Record<string, LocaleConfig>
-  markdown?: MarkdownOptions
   lastUpdated?: boolean
+
+  /**
+   * MarkdownIt options
+   */
+  markdown?: MarkdownOptions
   /**
    * Options to pass on to `@vitejs/plugin-vue`
    */
@@ -50,11 +54,6 @@ export interface UserConfig<ThemeConfig = any> {
    */
   vite?: ViteConfig
 
-  srcDir?: string
-  srcExclude?: string[]
-  outDir?: string
-  shouldPreload?: (link: string, page: string) => boolean
-
   /**
    * Configure the scroll offset when the theme has a sticky header.
    * Can be a number or a selector element to get the offset from.
@@ -311,7 +310,6 @@ export async function resolveSiteData(
     appearance: userConfig.appearance ?? true,
     themeConfig: userConfig.themeConfig || {},
     locales: userConfig.locales || {},
-    langs: createLangDictionary(userConfig),
     scrollOffset: userConfig.scrollOffset || 90,
     cleanUrls: userConfig.cleanUrls || 'disabled'
   }
@@ -329,8 +327,8 @@ function resolveSiteDataHead(userConfig?: UserConfig): HeadConfig[] {
       `
         ;(() => {
           const saved = localStorage.getItem('${APPEARANCE_KEY}')
-          const prefereDark = window.matchMedia('(prefers-color-scheme: dark)').matches
-          if (!saved || saved === 'auto' ? prefereDark : saved === 'dark') {
+          const prefersDark = window.matchMedia('(prefers-color-scheme: dark)').matches
+          if (!saved || saved === 'auto' ? prefersDark : saved === 'dark') {
             document.documentElement.classList.add('dark')
           }
         })()
diff --git a/src/node/index.ts b/src/node/index.ts
index 8dde346a7158..21b055cf4662 100644
--- a/src/node/index.ts
+++ b/src/node/index.ts
@@ -9,6 +9,5 @@ export type {
   SiteData,
   HeadConfig,
   Header,
-  LocaleConfig,
   DefaultTheme
 } from '../../types/shared'
diff --git a/src/node/markdown/markdown.ts b/src/node/markdown/markdown.ts
index bd9c3aef2999..c99e9705f4a6 100644
--- a/src/node/markdown/markdown.ts
+++ b/src/node/markdown/markdown.ts
@@ -24,7 +24,8 @@ import { snippetPlugin } from './plugins/snippet'
 import { preWrapperPlugin } from './plugins/preWrapper'
 import { linkPlugin } from './plugins/link'
 import { imagePlugin } from './plugins/image'
-import { Header } from '../shared'
+
+export type { Header } from '../shared'
 
 export type ThemeOptions =
   | IThemeRegistration
@@ -50,8 +51,6 @@ export interface MarkdownOptions extends MarkdownIt.Options {
 
 export type MarkdownRenderer = MarkdownIt
 
-export type { Header }
-
 export const createMarkdownRenderer = async (
   srcDir: string,
   options: MarkdownOptions = {},
diff --git a/src/shared/shared.ts b/src/shared/shared.ts
index 2459bafed1d5..90d5a427ba4d 100644
--- a/src/shared/shared.ts
+++ b/src/shared/shared.ts
@@ -1,15 +1,11 @@
-import {
-  SiteData,
-  PageData,
-  LocaleConfig,
-  HeadConfig
-} from '../../types/shared.js'
+import type { SiteData, PageData, HeadConfig } from '../../types/shared.js'
 
 export type {
   SiteData,
   PageData,
   HeadConfig,
   LocaleConfig,
+  LocaleSpecificConfig,
   Header,
   DefaultTheme,
   PageDataPayload,
@@ -19,6 +15,8 @@ export type {
 
 export const EXTERNAL_URL_RE = /^[a-z]+:/i
 export const APPEARANCE_KEY = 'vitepress-theme-appearance'
+export const HASH_RE = /#.*$/
+export const EXT_RE = /(index)?\.(md|html)$/
 
 export const inBrowser = typeof window !== 'undefined'
 
@@ -31,71 +29,70 @@ export const notFoundPageData: PageData = {
   lastUpdated: 0
 }
 
-function findMatchRoot(route: string, roots: string[]): string | undefined {
-  // first match to the routes with the most deep level.
-  roots.sort((a, b) => {
-    const levelDelta = b.split('/').length - a.split('/').length
-    if (levelDelta !== 0) {
-      return levelDelta
-    } else {
-      return b.length - a.length
-    }
-  })
+export function isActive(
+  currentPath: string,
+  matchPath?: string,
+  asRegex: boolean = false
+): boolean {
+  if (matchPath === undefined) {
+    return false
+  }
+
+  currentPath = normalize(`/${currentPath}`)
 
-  for (const r of roots) {
-    if (route.startsWith(r)) return r
+  if (asRegex) {
+    return new RegExp(matchPath).test(currentPath)
   }
+
+  if (normalize(matchPath) !== currentPath) {
+    return false
+  }
+
+  const hashMatch = matchPath.match(HASH_RE)
+
+  if (hashMatch) {
+    return (inBrowser ? location.hash : '') === hashMatch[0]
+  }
+
+  return true
 }
 
-function resolveLocales<T>(
-  locales: Record<string, T>,
-  route: string
-): T | undefined {
-  const localeRoot = findMatchRoot(route, Object.keys(locales))
-  return localeRoot ? locales[localeRoot] : undefined
+export function normalize(path: string): string {
+  return decodeURI(path).replace(HASH_RE, '').replace(EXT_RE, '')
 }
 
-export function createLangDictionary(siteData: {
-  themeConfig?: Record<string, any>
-  locales?: Record<string, LocaleConfig>
-}) {
-  const { locales } = siteData.themeConfig || {}
-  const siteLocales = siteData.locales
-  return locales && siteLocales
-    ? Object.keys(locales).reduce((langs, path) => {
-        langs[path] = {
-          label: locales![path].label,
-          lang: siteLocales[path].lang
-        }
-        return langs
-      }, {} as Record<string, { lang: string; label: string }>)
-    : {}
+export function isExternal(path: string): boolean {
+  return EXTERNAL_URL_RE.test(path)
 }
 
-// this merges the locales data to the main data by the route
+/**
+ * this merges the locales data to the main data by the route
+ */
 export function resolveSiteDataByRoute(
   siteData: SiteData,
-  route: string
+  relativePath: string
 ): SiteData {
-  route = cleanRoute(siteData, route)
-
-  const localeData = resolveLocales(siteData.locales || {}, route)
-  const localeThemeConfig = resolveLocales<any>(
-    siteData.themeConfig.locales || {},
-    route
-  )
-
-  // avoid object rest spread since this is going to run in the browser
-  // and spread is going to result in polyfill code
-  return Object.assign({}, siteData, localeData, {
-    themeConfig: Object.assign({}, siteData.themeConfig, localeThemeConfig, {
-      // clean the locales to reduce the bundle size
-      locales: {}
-    }),
-    lang: (localeData || siteData).lang,
-    // clean the locales to reduce the bundle size
-    locales: {},
-    langs: createLangDictionary(siteData)
+  const localeIndex =
+    Object.keys(siteData.locales).find(
+      (key) =>
+        key !== 'root' &&
+        !isExternal(key) &&
+        isActive(relativePath, `/${key}/`, true)
+    ) || 'root'
+
+  if (localeIndex === 'root') return siteData
+
+  return Object.assign({}, siteData, {
+    localeIndex,
+    lang: siteData.locales[localeIndex].lang ?? siteData.lang,
+    title: siteData.locales[localeIndex].title ?? siteData.title,
+    titleTemplate:
+      siteData.locales[localeIndex].titleTemplate ?? siteData.titleTemplate,
+    description:
+      siteData.locales[localeIndex].description ?? siteData.description,
+    head: mergeHead(siteData.locales[localeIndex].head ?? [], siteData.head),
+    themeConfig:
+      siteData.locales[localeIndex].themeConfig ?? siteData.themeConfig
   })
 }
 
@@ -134,20 +131,6 @@ function createTitleTemplate(
   return ` | ${template}`
 }
 
-/**
- * Clean up the route by removing the `base` path if it's set in config.
- */
-function cleanRoute(siteData: SiteData, route: string): string {
-  if (!inBrowser) {
-    return route
-  }
-
-  const base = siteData.base
-  const baseWithoutSuffix = base.endsWith('/') ? base.slice(0, -1) : base
-
-  return route.slice(baseWithoutSuffix.length)
-}
-
 function hasTag(head: HeadConfig[], tag: HeadConfig) {
   const [tagType, tagAttrs] = tag
   if (tagType !== 'meta') return false
diff --git a/types/default-theme.d.ts b/types/default-theme.d.ts
index 36ba6f0d68f4..041a091822af 100644
--- a/types/default-theme.d.ts
+++ b/types/default-theme.d.ts
@@ -20,13 +20,6 @@ export namespace DefaultTheme {
      */
     outline?: number | [number, number] | 'deep' | false
 
-    /**
-     * Custom outline title in the aside component.
-     *
-     * @default 'On this page'
-     */
-    outlineTitle?: string
-
     /**
      * The nav items.
      */
@@ -43,18 +36,6 @@ export namespace DefaultTheme {
      */
     editLink?: EditLink
 
-    /**
-     * Set custom last updated text.
-     *
-     * @default 'Last updated'
-     */
-    lastUpdatedText?: string
-
-    /**
-     * Set custom prev/next labels.
-     */
-    docFooter?: DocFooter
-
     /**
      * The social links to be displayed at the end of the nav bar. Perfect for
      * placing links to social services such as GitHub, Twitter, Facebook, etc.
@@ -66,12 +47,6 @@ export namespace DefaultTheme {
      */
     footer?: Footer
 
-    /**
-     * Adds locale menu to the nav. This option should be used when you have
-     * your translated sites outside of the project.
-     */
-    localeLinks?: LocaleLinks
-
     /**
      * The algolia options. Leave it undefined to disable the search feature.
      */
@@ -81,6 +56,48 @@ export namespace DefaultTheme {
      * The carbon ads options. Leave it undefined to disable the ads feature.
      */
     carbonAds?: CarbonAdsOptions
+
+    /**
+     * Custom labels
+     */
+    translations?: {
+      /**
+       * @default 'On this page'
+       */
+      outlineTitle?: string
+
+      /**
+       * @default 'Last updated'
+       */
+      lastUpdatedText?: string
+
+      docFooter?: {
+        /**
+         * @default 'Previous page'
+         */
+        prev?: string
+
+        /**
+         * @default 'Next page'
+         */
+        next?: string
+      }
+
+      /**
+       * @default 'Appearance'
+       */
+      darkModeSwitchLabel?: string
+
+      /**
+       * @default 'Menu'
+       */
+      sidebarMenuLabel?: string
+
+      /**
+       * @default 'Return to top'
+       */
+      returnToTopLabel?: string
+    }
   }
 
   // nav -----------------------------------------------------------------------
@@ -168,24 +185,6 @@ export namespace DefaultTheme {
     text?: string
   }
 
-  // prev-next -----------------------------------------------------------------
-
-  export interface DocFooter {
-    /**
-     * Custom label for previous page button.
-     *
-     * @default 'Previous page'
-     */
-    prev?: string
-
-    /**
-     * Custom label for next page button.
-     *
-     * @default 'Next page'
-     */
-    next?: string
-  }
-
   // social link ---------------------------------------------------------------
 
   export interface SocialLink {
@@ -224,18 +223,6 @@ export namespace DefaultTheme {
     sponsor?: string
   }
 
-  // locales -------------------------------------------------------------------
-
-  export interface LocaleLinks {
-    text: string
-    items: LocaleLink[]
-  }
-
-  export interface LocaleLink {
-    text: string
-    link: string
-  }
-
   // algolia ------------------------------------------------------------------
 
   /**
diff --git a/types/shared.d.ts b/types/shared.d.ts
index f37194dc1c24..ee1ace4c1f2c 100644
--- a/types/shared.d.ts
+++ b/types/shared.d.ts
@@ -50,14 +50,7 @@ export type CleanUrlsMode =
 export interface SiteData<ThemeConfig = any> {
   base: string
   cleanUrls?: CleanUrlsMode
-
-  /**
-   * Language of the site as it should be set on the `html` element.
-   *
-   * @example `en-US`, `zh-CN`
-   */
   lang: string
-
   title: string
   titleTemplate?: string | boolean
   description: string
@@ -65,45 +58,29 @@ export interface SiteData<ThemeConfig = any> {
   appearance: boolean
   themeConfig: ThemeConfig
   scrollOffset: number | string
-  locales: Record<string, LocaleConfig>
-
-  /**
-   * Available locales for the site when it has defined `locales` in its
-   * `themeConfig`. This object is otherwise empty. Keys are paths like `/` or
-   * `/zh/`.
-   */
-  langs: Record<
-    string,
-    {
-      /**
-       * Lang attribute as set on the `<html>` element.
-       * @example `en-US`, `zh-CN`
-       */
-      lang: string
-      /**
-       * Label to display in the language menu.
-       * @example `English`, `简体中文`
-       */
-      label: string
-    }
-  >
+  locales: LocaleConfig<ThemeConfig>
+  localeIndex?: string
 }
 
 export type HeadConfig =
   | [string, Record<string, string>]
   | [string, Record<string, string>, string]
 
-export interface LocaleConfig {
-  lang: string
+export interface PageDataPayload {
+  path: string
+  pageData: PageData
+}
+
+export interface LocaleSpecificConfig<ThemeConfig = any> {
+  lang?: string
   title?: string
   titleTemplate?: string | boolean
   description?: string
   head?: HeadConfig[]
-  label?: string
-  selectText?: string
+  themeConfig?: ThemeConfig
 }
 
-export interface PageDataPayload {
-  path: string
-  pageData: PageData
-}
+export type LocaleConfig<ThemeConfig = any> = Record<
+  string,
+  LocaleSpecificConfig<ThemeConfig> & { label: string; link?: string }
+>

From cf77a3905dbf3797f3accc52ffba1c9cf2d56dee Mon Sep 17 00:00:00 2001
From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Date: Fri, 9 Sep 2022 11:11:15 +0530
Subject: [PATCH 02/24] fix carbon ads

---
 .../theme-default/components/VPDocAside.vue    |  8 ++++++--
 .../components/VPDocAsideCarbonAds.vue         | 18 ------------------
 2 files changed, 6 insertions(+), 20 deletions(-)
 delete mode 100644 src/client/theme-default/components/VPDocAsideCarbonAds.vue

diff --git a/src/client/theme-default/components/VPDocAside.vue b/src/client/theme-default/components/VPDocAside.vue
index ab7084276eab..10bbbb429533 100644
--- a/src/client/theme-default/components/VPDocAside.vue
+++ b/src/client/theme-default/components/VPDocAside.vue
@@ -1,9 +1,13 @@
 <script setup lang="ts">
+import { defineAsyncComponent } from 'vue'
 import { useData } from 'vitepress'
 import VPDocAsideOutline from './VPDocAsideOutline.vue'
-import VPDocAsideCarbonAds from './VPDocAsideCarbonAds.vue'
 
 const { theme } = useData()
+
+const VPCarbonAds = __CARBON__
+  ? defineAsyncComponent(() => import('./VPCarbonAds.vue'))
+  : () => null
 </script>
 
 <template>
@@ -17,7 +21,7 @@ const { theme } = useData()
     <div class="spacer" />
 
     <slot name="aside-ads-before" />
-    <VPDocAsideCarbonAds v-if="theme.carbonAds" :carbonAds="theme.carbonAds" />
+    <VPCarbonAds v-if="theme.carbonAds" :carbonAds="theme.carbonAds" />
     <slot name="aside-ads-after" />
 
     <slot name="aside-bottom" />
diff --git a/src/client/theme-default/components/VPDocAsideCarbonAds.vue b/src/client/theme-default/components/VPDocAsideCarbonAds.vue
deleted file mode 100644
index 9d56016f6572..000000000000
--- a/src/client/theme-default/components/VPDocAsideCarbonAds.vue
+++ /dev/null
@@ -1,18 +0,0 @@
-<script setup lang="ts">
-import type { DefaultTheme } from 'vitepress/theme'
-import { defineAsyncComponent } from 'vue'
-
-const props = defineProps<{
-  carbonAds: DefaultTheme.CarbonAdsOptions
-}>()
-
-const VPCarbonAds = __CARBON__
-  ? defineAsyncComponent(() => import('./VPCarbonAds.vue'))
-  : () => null
-</script>
-
-<template>
-  <div class="VPDocAsideCarbonAds">
-    <VPCarbonAds :carbonAds="props" />
-  </div>
-</template>

From 5ed5ff9c42513920f1738c0ec332f87ff87e5b40 Mon Sep 17 00:00:00 2001
From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Date: Sat, 10 Sep 2022 01:23:23 +0530
Subject: [PATCH 03/24] feat: support using .vitepress/config/index.ts

---
 src/node/config.ts | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/node/config.ts b/src/node/config.ts
index bc1500564014..bd05c2590711 100644
--- a/src/node/config.ts
+++ b/src/node/config.ts
@@ -227,7 +227,10 @@ async function resolveUserConfig(
 ): Promise<[UserConfig, string | undefined, string[]]> {
   // load user config
   const configPath = supportedConfigExtensions
-    .map((ext) => resolve(root, `config.${ext}`))
+    .flatMap((ext) => [
+      resolve(root, `config/index.${ext}`),
+      resolve(root, `config.${ext}`)
+    ])
     .find(fs.pathExistsSync)
 
   let userConfig: RawConfigExports = {}

From 74f0206be5f5c32aacf753f228be8100ff77323f Mon Sep 17 00:00:00 2001
From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Date: Sat, 10 Sep 2022 10:19:52 +0530
Subject: [PATCH 04/24] feat: merge theme config too

---
 src/client/theme-default/composables/langs.ts | 13 +++----------
 src/shared/shared.ts                          | 18 +++++++++---------
 2 files changed, 12 insertions(+), 19 deletions(-)

diff --git a/src/client/theme-default/composables/langs.ts b/src/client/theme-default/composables/langs.ts
index b79c17e72cbf..b4af79dc6718 100644
--- a/src/client/theme-default/composables/langs.ts
+++ b/src/client/theme-default/composables/langs.ts
@@ -1,15 +1,13 @@
 import { computed } from 'vue'
 import { useData } from 'vitepress'
-import { isExternal } from '../support/utils.js'
 
 export function useLangs() {
   const { site, localeIndex } = useData()
   const currentLang = computed(() => ({
     label: site.value.locales[localeIndex.value]?.label,
     link:
-      localeIndex.value === 'root'
-        ? '/'
-        : site.value.locales[localeIndex.value].link || `/${localeIndex.value}/`
+      site.value.locales[localeIndex.value]?.link ||
+      (localeIndex.value === 'root' ? '/' : `/${localeIndex.value}/`)
   }))
 
   const localeLinks = computed(() =>
@@ -18,12 +16,7 @@ export function useLangs() {
         ? []
         : {
             text: value.label,
-            link:
-              key === 'root'
-                ? '/'
-                : isExternal(key)
-                ? key
-                : value.link || `/${key}/`
+            link: value.link || (key === 'root' ? '/' : `/${key}/`)
           }
     )
   )
diff --git a/src/shared/shared.ts b/src/shared/shared.ts
index 90d5a427ba4d..51101745aa6d 100644
--- a/src/shared/shared.ts
+++ b/src/shared/shared.ts
@@ -80,19 +80,19 @@ export function resolveSiteDataByRoute(
         isActive(relativePath, `/${key}/`, true)
     ) || 'root'
 
-  if (localeIndex === 'root') return siteData
-
   return Object.assign({}, siteData, {
     localeIndex,
-    lang: siteData.locales[localeIndex].lang ?? siteData.lang,
-    title: siteData.locales[localeIndex].title ?? siteData.title,
+    lang: siteData.locales[localeIndex]?.lang ?? siteData.lang,
+    title: siteData.locales[localeIndex]?.title ?? siteData.title,
     titleTemplate:
-      siteData.locales[localeIndex].titleTemplate ?? siteData.titleTemplate,
+      siteData.locales[localeIndex]?.titleTemplate ?? siteData.titleTemplate,
     description:
-      siteData.locales[localeIndex].description ?? siteData.description,
-    head: mergeHead(siteData.locales[localeIndex].head ?? [], siteData.head),
-    themeConfig:
-      siteData.locales[localeIndex].themeConfig ?? siteData.themeConfig
+      siteData.locales[localeIndex]?.description ?? siteData.description,
+    head: mergeHead(siteData.head, siteData.locales[localeIndex]?.head ?? []),
+    themeConfig: {
+      ...siteData.themeConfig,
+      ...siteData.locales[localeIndex]?.themeConfig
+    }
   })
 }
 

From 2509ab9a209006b5d8c038f4430bd6f0e0eb340d Mon Sep 17 00:00:00 2001
From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Date: Sat, 10 Sep 2022 11:01:39 +0530
Subject: [PATCH 05/24] fix: don't add base to relative links

---
 src/client/app/utils.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/client/app/utils.ts b/src/client/app/utils.ts
index 2f8be606544a..3e901c5b4418 100644
--- a/src/client/app/utils.ts
+++ b/src/client/app/utils.ts
@@ -11,7 +11,7 @@ export function joinPath(base: string, path: string): string {
 }
 
 export function withBase(path: string) {
-  return EXTERNAL_URL_RE.test(path)
+  return EXTERNAL_URL_RE.test(path) || path.startsWith('.')
     ? path
     : joinPath(siteDataRef.value.base, path)
 }

From ad8a368f315e770ac8c4e8a13da8fbffeccbd0e3 Mon Sep 17 00:00:00 2001
From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Date: Sat, 10 Sep 2022 18:26:16 +0530
Subject: [PATCH 06/24] fix: don't remove relative part from url during
 normalization

---
 src/client/theme-default/support/utils.ts | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/src/client/theme-default/support/utils.ts b/src/client/theme-default/support/utils.ts
index 3056cb973aa3..fea9d463dd87 100644
--- a/src/client/theme-default/support/utils.ts
+++ b/src/client/theme-default/support/utils.ts
@@ -39,10 +39,13 @@ export function normalizeLink(url: string): string {
   const normalizedPath =
     pathname.endsWith('/') || pathname.endsWith('.html')
       ? url
-      : `${pathname.replace(
-          /(\.md)?$/,
-          site.value.cleanUrls === 'disabled' ? '.html' : ''
-        )}${search}${hash}`
+      : url.replace(
+          /(?:(^\.+)\/)?.*$/,
+          `$1${pathname.replace(
+            /(\.md)?$/,
+            site.value.cleanUrls === 'disabled' ? '.html' : ''
+          )}${search}${hash}`
+        )
 
   return withBase(normalizedPath)
 }

From fd0beb59e631966c6153cecf9518b22f888b73d8 Mon Sep 17 00:00:00 2001
From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Date: Wed, 14 Sep 2022 23:56:21 +0530
Subject: [PATCH 07/24] feat: allow specifying dir attribute for html

---
 src/client/app/data.ts   |  2 ++
 src/client/app/index.ts  | 13 +++++--------
 src/node/build/render.ts |  2 +-
 src/node/config.ts       |  1 +
 src/shared/shared.ts     |  1 +
 types/shared.d.ts        |  2 ++
 6 files changed, 12 insertions(+), 9 deletions(-)

diff --git a/src/client/app/data.ts b/src/client/app/data.ts
index 3d9508090c68..1bd90b8ecddb 100644
--- a/src/client/app/data.ts
+++ b/src/client/app/data.ts
@@ -19,6 +19,7 @@ export interface VitePressData<T = any> {
   title: Ref<string>
   description: Ref<string>
   lang: Ref<string>
+  dir: Ref<string>
   localeIndex: Ref<string>
 }
 
@@ -48,6 +49,7 @@ export function initData(route: Route): VitePressData {
     page: computed(() => route.data),
     frontmatter: computed(() => route.data.frontmatter),
     lang: computed(() => site.value.lang),
+    dir: computed(() => site.value.dir),
     localeIndex: computed(() => site.value.localeIndex || 'root'),
     title: computed(() => {
       return createTitle(site.value, route.data)
diff --git a/src/client/app/index.ts b/src/client/app/index.ts
index 84bd1c23da8b..acf92c0b32b5 100644
--- a/src/client/app/index.ts
+++ b/src/client/app/index.ts
@@ -5,7 +5,7 @@ import {
   defineComponent,
   h,
   onMounted,
-  watch
+  watchEffect
 } from 'vue'
 import Theme from '@theme/index'
 import { inBrowser, pathToFile } from './utils.js'
@@ -27,13 +27,10 @@ const VitePressApp = defineComponent({
 
     // change the language on the HTML element based on the current lang
     onMounted(() => {
-      watch(
-        () => site.value.lang,
-        (lang: string) => {
-          document.documentElement.lang = lang
-        },
-        { immediate: true }
-      )
+      watchEffect(() => {
+        document.documentElement.lang = site.value.lang
+        document.documentElement.dir = site.value.dir
+      })
     })
 
     if (import.meta.env.PROD) {
diff --git a/src/node/build/render.ts b/src/node/build/render.ts
index f706764821c8..a701003b94c8 100644
--- a/src/node/build/render.ts
+++ b/src/node/build/render.ts
@@ -144,7 +144,7 @@ export async function renderPage(
 
   const html = `
 <!DOCTYPE html>
-<html lang="${siteData.lang}">
+<html lang="${siteData.lang}" dir="${siteData.dir}">
   <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width,initial-scale=1">
diff --git a/src/node/config.ts b/src/node/config.ts
index 3920a0cd8fe1..8941434a2f69 100644
--- a/src/node/config.ts
+++ b/src/node/config.ts
@@ -316,6 +316,7 @@ export async function resolveSiteData(
 
   return {
     lang: userConfig.lang || 'en-US',
+    dir: userConfig.dir || 'ltr',
     title: userConfig.title || 'VitePress',
     titleTemplate: userConfig.titleTemplate,
     description: userConfig.description || 'A VitePress site',
diff --git a/src/shared/shared.ts b/src/shared/shared.ts
index 51101745aa6d..0ac515dc7dc3 100644
--- a/src/shared/shared.ts
+++ b/src/shared/shared.ts
@@ -83,6 +83,7 @@ export function resolveSiteDataByRoute(
   return Object.assign({}, siteData, {
     localeIndex,
     lang: siteData.locales[localeIndex]?.lang ?? siteData.lang,
+    dir: siteData.locales[localeIndex]?.dir ?? siteData.dir,
     title: siteData.locales[localeIndex]?.title ?? siteData.title,
     titleTemplate:
       siteData.locales[localeIndex]?.titleTemplate ?? siteData.titleTemplate,
diff --git a/types/shared.d.ts b/types/shared.d.ts
index ee1ace4c1f2c..24a41a036261 100644
--- a/types/shared.d.ts
+++ b/types/shared.d.ts
@@ -51,6 +51,7 @@ export interface SiteData<ThemeConfig = any> {
   base: string
   cleanUrls?: CleanUrlsMode
   lang: string
+  dir: string
   title: string
   titleTemplate?: string | boolean
   description: string
@@ -73,6 +74,7 @@ export interface PageDataPayload {
 
 export interface LocaleSpecificConfig<ThemeConfig = any> {
   lang?: string
+  dir?: string
   title?: string
   titleTemplate?: string | boolean
   description?: string

From df14075037d19030128f7f01957c71b608ad0687 Mon Sep 17 00:00:00 2001
From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Date: Fri, 16 Sep 2022 11:39:52 +0530
Subject: [PATCH 08/24] remove stuff from translations

---
 .../components/VPDocAsideOutline.vue          |   8 +-
 .../theme-default/components/VPDocFooter.vue  |   4 +-
 .../components/VPDocFooterLastUpdated.vue     |   2 +-
 .../theme-default/components/VPLocalNav.vue   |   4 +-
 .../components/VPNavBarExtra.vue              |   2 +-
 .../components/VPNavScreenAppearance.vue      |   2 +-
 .../theme-default/composables/outline.ts      |   7 +-
 types/default-theme.d.ts                      | 104 ++++++++++--------
 8 files changed, 81 insertions(+), 52 deletions(-)

diff --git a/src/client/theme-default/components/VPDocAsideOutline.vue b/src/client/theme-default/components/VPDocAsideOutline.vue
index cd8e8f91416a..197436ba7c2a 100644
--- a/src/client/theme-default/components/VPDocAsideOutline.vue
+++ b/src/client/theme-default/components/VPDocAsideOutline.vue
@@ -43,7 +43,13 @@ function handleClick({ target: el }: Event) {
       <div class="outline-marker" ref="marker" />
 
       <div class="outline-title">
-        {{ theme.translations?.outlineTitle || 'On this page' }}
+        {{
+          (typeof theme.outline === 'object' &&
+            !Array.isArray(theme.outline) &&
+            theme.outline.label) ||
+          theme.outlineTitle ||
+          'On this page'
+        }}
       </div>
 
       <nav aria-labelledby="doc-outline-aria-label">
diff --git a/src/client/theme-default/components/VPDocFooter.vue b/src/client/theme-default/components/VPDocFooter.vue
index 5441a3e757ab..4a475b299eb1 100644
--- a/src/client/theme-default/components/VPDocFooter.vue
+++ b/src/client/theme-default/components/VPDocFooter.vue
@@ -42,13 +42,13 @@ const showFooter = computed(() => {
     <div v-if="control.prev || control.next" class="prev-next">
       <div class="pager">
         <a v-if="control.prev" class="pager-link prev" :href="normalizeLink(control.prev.link)">
-          <span class="desc">{{ theme.translations?.docFooter?.prev || 'Previous page' }}</span>
+          <span class="desc">{{ theme.docFooter?.prev || 'Previous page' }}</span>
           <span class="title">{{ control.prev.text }} </span>
         </a>
       </div>
       <div class="pager" :class="{ 'has-prev': control.prev }">
         <a v-if="control.next" class="pager-link next" :href="normalizeLink(control.next.link)">
-          <span class="desc">{{ theme.translations?.docFooter?.next || 'Next page' }}</span>
+          <span class="desc">{{ theme.docFooter?.next || 'Next page' }}</span>
           <span class="title">{{ control.next.text }}</span>
         </a>
       </div>
diff --git a/src/client/theme-default/components/VPDocFooterLastUpdated.vue b/src/client/theme-default/components/VPDocFooterLastUpdated.vue
index 1ac29682bb9f..30c047d15708 100644
--- a/src/client/theme-default/components/VPDocFooterLastUpdated.vue
+++ b/src/client/theme-default/components/VPDocFooterLastUpdated.vue
@@ -20,7 +20,7 @@ onMounted(() => {
 
 <template>
   <p class="VPLastUpdated">
-    {{ theme.translations?.lastUpdatedText || 'Last updated' }}:
+    {{ theme.lastUpdatedText || 'Last updated' }}:
     <time :datatime="isoDatetime">{{ datetime }}</time>
   </p>
 </template>
diff --git a/src/client/theme-default/components/VPLocalNav.vue b/src/client/theme-default/components/VPLocalNav.vue
index 4833a5ee2840..e92846dafab7 100644
--- a/src/client/theme-default/components/VPLocalNav.vue
+++ b/src/client/theme-default/components/VPLocalNav.vue
@@ -29,12 +29,12 @@ function scrollToTop() {
     >
       <VPIconAlignLeft class="menu-icon" />
       <span class="menu-text">
-        {{ theme.translations?.sidebarMenuLabel || 'Menu' }}
+        {{ theme.sidebarMenuLabel || 'Menu' }}
       </span>
     </button>
 
     <a class="top-link" href="#" @click="scrollToTop">
-      {{ theme.translations?.returnToTopLabel || 'Return to top' }}
+      {{ theme.returnToTopLabel || 'Return to top' }}
     </a>
   </div>
 </template>
diff --git a/src/client/theme-default/components/VPNavBarExtra.vue b/src/client/theme-default/components/VPNavBarExtra.vue
index 35966cc6bb26..65b6dda5264c 100644
--- a/src/client/theme-default/components/VPNavBarExtra.vue
+++ b/src/client/theme-default/components/VPNavBarExtra.vue
@@ -31,7 +31,7 @@ const hasExtraContent = computed(
     <div v-if="site.appearance" class="group">
       <div class="item appearance">
         <p class="label">
-          {{ theme.translations?.darkModeSwitchLabel || 'Appearance' }}
+          {{ theme.darkModeSwitchLabel || 'Appearance' }}
         </p>
         <div class="appearance-action">
           <VPSwitchAppearance />
diff --git a/src/client/theme-default/components/VPNavScreenAppearance.vue b/src/client/theme-default/components/VPNavScreenAppearance.vue
index 87bbcb4d05de..1bff9cad923d 100644
--- a/src/client/theme-default/components/VPNavScreenAppearance.vue
+++ b/src/client/theme-default/components/VPNavScreenAppearance.vue
@@ -8,7 +8,7 @@ const { site, theme } = useData()
 <template>
   <div v-if="site.appearance" class="VPNavScreenAppearance">
     <p class="text">
-      {{ theme.translations?.darkModeSwitchLabel || 'Appearance' }}
+      {{ theme.darkModeSwitchLabel || 'Appearance' }}
     </p>
     <VPSwitchAppearance />
   </div>
diff --git a/src/client/theme-default/composables/outline.ts b/src/client/theme-default/composables/outline.ts
index 9467d0f1cbae..9ddfec282889 100644
--- a/src/client/theme-default/composables/outline.ts
+++ b/src/client/theme-default/composables/outline.ts
@@ -30,8 +30,13 @@ export function getHeaders(pageOutline: DefaultTheme.Config['outline']) {
 
 export function resolveHeaders(
   headers: MenuItem[],
-  levelsRange: Exclude<DefaultTheme.Config['outline'], false> = 2
+  range?: Exclude<DefaultTheme.Config['outline'], false>
 ) {
+  const levelsRange =
+    (typeof range === 'object' && !Array.isArray(range)
+      ? range.level
+      : range) || 2
+
   const levels: [number, number] =
     typeof levelsRange === 'number'
       ? [levelsRange, levelsRange]
diff --git a/types/default-theme.d.ts b/types/default-theme.d.ts
index 041a091822af..16895e2bcc56 100644
--- a/types/default-theme.d.ts
+++ b/types/default-theme.d.ts
@@ -18,7 +18,15 @@ export namespace DefaultTheme {
      *
      * @default 2
      */
-    outline?: number | [number, number] | 'deep' | false
+    outline?: Outline | Outline['level'] | false
+
+    /**
+     * @deprecated
+     * Use `outline.label` instead.
+     *
+     * @default 'On this page'
+     */
+    outlineTitle?: string
 
     /**
      * The nav items.
@@ -36,6 +44,18 @@ export namespace DefaultTheme {
      */
     editLink?: EditLink
 
+    /**
+     * Set custom last updated text.
+     *
+     * @default 'Last updated'
+     */
+    lastUpdatedText?: string
+
+    /**
+     * Set custom prev/next labels.
+     */
+    docFooter?: DocFooter
+
     /**
      * The social links to be displayed at the end of the nav bar. Perfect for
      * placing links to social services such as GitHub, Twitter, Facebook, etc.
@@ -47,6 +67,21 @@ export namespace DefaultTheme {
      */
     footer?: Footer
 
+    /**
+     * @default 'Appearance'
+     */
+    darkModeSwitchLabel?: string
+
+    /**
+     * @default 'Menu'
+     */
+    sidebarMenuLabel?: string
+
+    /**
+     * @default 'Return to top'
+     */
+    returnToTopLabel?: string
+
     /**
      * The algolia options. Leave it undefined to disable the search feature.
      */
@@ -56,48 +91,6 @@ export namespace DefaultTheme {
      * The carbon ads options. Leave it undefined to disable the ads feature.
      */
     carbonAds?: CarbonAdsOptions
-
-    /**
-     * Custom labels
-     */
-    translations?: {
-      /**
-       * @default 'On this page'
-       */
-      outlineTitle?: string
-
-      /**
-       * @default 'Last updated'
-       */
-      lastUpdatedText?: string
-
-      docFooter?: {
-        /**
-         * @default 'Previous page'
-         */
-        prev?: string
-
-        /**
-         * @default 'Next page'
-         */
-        next?: string
-      }
-
-      /**
-       * @default 'Appearance'
-       */
-      darkModeSwitchLabel?: string
-
-      /**
-       * @default 'Menu'
-       */
-      sidebarMenuLabel?: string
-
-      /**
-       * @default 'Return to top'
-       */
-      returnToTopLabel?: string
-    }
   }
 
   // nav -----------------------------------------------------------------------
@@ -185,6 +178,24 @@ export namespace DefaultTheme {
     text?: string
   }
 
+  // prev-next -----------------------------------------------------------------
+
+  export interface DocFooter {
+    /**
+     * Custom label for previous page button.
+     *
+     * @default 'Previous page'
+     */
+    prev?: string
+
+    /**
+     * Custom label for next page button.
+     *
+     * @default 'Next page'
+     */
+    next?: string
+  }
+
   // social link ---------------------------------------------------------------
 
   export interface SocialLink {
@@ -223,6 +234,13 @@ export namespace DefaultTheme {
     sponsor?: string
   }
 
+  // outline -------------------------------------------------------------------
+
+  export interface Outline {
+    level?: number | [number, number] | 'deep'
+    label?: string
+  }
+
   // algolia ------------------------------------------------------------------
 
   /**

From 335c0b38f9b73ad4c23ba75f5ffe911c6c6969c9 Mon Sep 17 00:00:00 2001
From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Date: Wed, 28 Sep 2022 11:57:04 +0530
Subject: [PATCH 09/24] feat: use current locale link in 404 page

---
 src/client/theme-default/NotFound.vue         | 19 +++++++++++++++++--
 src/client/theme-default/composables/langs.ts |  4 ++--
 2 files changed, 19 insertions(+), 4 deletions(-)

diff --git a/src/client/theme-default/NotFound.vue b/src/client/theme-default/NotFound.vue
index 193d11cdda09..cf9525fb8dd0 100644
--- a/src/client/theme-default/NotFound.vue
+++ b/src/client/theme-default/NotFound.vue
@@ -1,7 +1,22 @@
 <script setup lang="ts">
-import { useData } from 'vitepress'
+import { onMounted, ref } from 'vue'
+import { useData, withBase } from 'vitepress'
+import { useLangs } from './composables/langs.js'
 
 const { site } = useData()
+const { localeLinks } = useLangs(false)
+
+const root = ref('/')
+onMounted(() => {
+  const path = window.location.pathname
+    .replace(site.value.base, '')
+    .replace(/(^.*?\/).*$/, '/$1')
+  if (localeLinks.value.length) {
+    root.value =
+      localeLinks.value.find(({ link }) => link.startsWith(path))?.link ||
+      localeLinks.value[0].link
+  }
+})
 </script>
 
 <template>
@@ -14,7 +29,7 @@ const { site } = useData()
     </blockquote>
 
     <div class="action">
-      <a class="link" :href="site.base" aria-label="go to home">
+      <a class="link" :href="withBase(root)" aria-label="go to home">
         Take me home
       </a>
     </div>
diff --git a/src/client/theme-default/composables/langs.ts b/src/client/theme-default/composables/langs.ts
index b4af79dc6718..9140cb244449 100644
--- a/src/client/theme-default/composables/langs.ts
+++ b/src/client/theme-default/composables/langs.ts
@@ -1,7 +1,7 @@
 import { computed } from 'vue'
 import { useData } from 'vitepress'
 
-export function useLangs() {
+export function useLangs(removeCurrent = true) {
   const { site, localeIndex } = useData()
   const currentLang = computed(() => ({
     label: site.value.locales[localeIndex.value]?.label,
@@ -12,7 +12,7 @@ export function useLangs() {
 
   const localeLinks = computed(() =>
     Object.entries(site.value.locales).flatMap(([key, value]) =>
-      currentLang.value.label === value.label
+      removeCurrent && currentLang.value.label === value.label
         ? []
         : {
             text: value.label,

From 064857ca2d19f07ea2c724c475a27918a015d891 Mon Sep 17 00:00:00 2001
From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Date: Tue, 11 Oct 2022 20:04:31 +0530
Subject: [PATCH 10/24] fix(theme): properly apply base in locale links

Co-authored-by: Hiroki Okada <hirokio@tutanota.com>
---
 .../theme-default/components/VPNavScreenTranslations.vue       | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/client/theme-default/components/VPNavScreenTranslations.vue b/src/client/theme-default/components/VPNavScreenTranslations.vue
index 68b0388aef3e..6ab174fb9a57 100644
--- a/src/client/theme-default/components/VPNavScreenTranslations.vue
+++ b/src/client/theme-default/components/VPNavScreenTranslations.vue
@@ -3,6 +3,7 @@ import { ref } from 'vue'
 import VPIconChevronDown from './icons/VPIconChevronDown.vue'
 import VPIconLanguages from './icons/VPIconLanguages.vue'
 import { useLangs } from '../composables/langs.js'
+import VPLink from './VPLink.vue'
 
 const { localeLinks, currentLang } = useLangs()
 const isOpen = ref(false)
@@ -26,7 +27,7 @@ function toggle() {
 
     <ul class="list">
       <li v-for="locale in localeLinks" :key="locale.link" class="item">
-        <a class="link" :href="locale.link">{{ locale.text }}</a>
+        <VPLink class="link" :href="locale.link">{{ locale.text }}</VPLink>
       </li>
     </ul>
   </div>

From b4e148368695c98164480a3626c114468f77d484 Mon Sep 17 00:00:00 2001
From: Sadegh Barati <sadeghbaratiwork@gmail.com>
Date: Mon, 7 Nov 2022 18:49:45 +0330
Subject: [PATCH 11/24] feat(theme): add rtlcss directive (#1512)

Co-authored-by: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
---
 src/client/theme-default/components/VPBackdrop.vue  |  2 ++
 src/client/theme-default/components/VPHero.vue      |  5 +++++
 src/client/theme-default/components/VPLocalNav.vue  |  1 +
 src/client/theme-default/components/VPNav.vue       |  1 +
 .../theme-default/components/VPNavBarSearch.vue     |  6 ++++++
 src/client/theme-default/components/VPNavScreen.vue |  2 ++
 .../components/VPNavScreenMenuGroup.vue             |  1 +
 src/client/theme-default/components/VPSwitch.vue    |  1 +
 .../theme-default/components/VPSwitchAppearance.vue |  1 +
 .../theme-default/styles/components/vp-doc.css      | 13 +++++++++++++
 10 files changed, 33 insertions(+)

diff --git a/src/client/theme-default/components/VPBackdrop.vue b/src/client/theme-default/components/VPBackdrop.vue
index 1aa5d0b14b17..b7b1cf38d97e 100644
--- a/src/client/theme-default/components/VPBackdrop.vue
+++ b/src/client/theme-default/components/VPBackdrop.vue
@@ -14,8 +14,10 @@ defineProps<{
 .VPBackdrop {
   position: fixed;
   top: 0;
+  /*rtl:ignore*/
   right: 0;
   bottom: 0;
+  /*rtl:ignore*/
   left: 0;
   z-index: var(--vp-z-index-backdrop);
   background: rgba(0, 0, 0, .6);
diff --git a/src/client/theme-default/components/VPHero.vue b/src/client/theme-default/components/VPHero.vue
index 4e764c27152f..bb396a0a8ffa 100644
--- a/src/client/theme-default/components/VPHero.vue
+++ b/src/client/theme-default/components/VPHero.vue
@@ -262,6 +262,7 @@ defineProps<{
     align-items: center;
     width: 100%;
     height: 100%;
+    /*rtl:ignore*/
     transform: translate(-32px, -32px);
   }
 }
@@ -269,12 +270,14 @@ defineProps<{
 .image-bg {
   position: absolute;
   top: 50%;
+  /*rtl:ignore*/
   left: 50%;
   border-radius: 50%;
   width: 192px;
   height: 192px;
   background-image: var(--vp-home-hero-image-background-image);
   filter: var(--vp-home-hero-image-filter);
+  /*rtl:ignore*/
   transform: translate(-50%, -50%);
 }
 
@@ -295,8 +298,10 @@ defineProps<{
 :deep(.image-src) {
   position: absolute;
   top: 50%;
+  /*rtl:ignore*/
   left: 50%;
   max-width: 192px;
+  /*rtl:ignore*/
   transform: translate(-50%, -50%);
 }
 
diff --git a/src/client/theme-default/components/VPLocalNav.vue b/src/client/theme-default/components/VPLocalNav.vue
index bb8d023228b3..6e4729eb4008 100644
--- a/src/client/theme-default/components/VPLocalNav.vue
+++ b/src/client/theme-default/components/VPLocalNav.vue
@@ -43,6 +43,7 @@ function scrollToTop() {
 .VPLocalNav {
   position: sticky;
   top: 0;
+  /*rtl:ignore*/
   left: 0;
   z-index: var(--vp-z-index-local-nav);
   display: flex;
diff --git a/src/client/theme-default/components/VPNav.vue b/src/client/theme-default/components/VPNav.vue
index 19b7e6399fcb..0461f60527b0 100644
--- a/src/client/theme-default/components/VPNav.vue
+++ b/src/client/theme-default/components/VPNav.vue
@@ -30,6 +30,7 @@ provide('close-screen', closeScreen)
 .VPNav {
   position: relative;
   top: var(--vp-layout-top-height, 0px);
+  /*rtl:ignore*/
   left: 0;
   z-index: var(--vp-z-index-nav);
   width: 100%;
diff --git a/src/client/theme-default/components/VPNavBarSearch.vue b/src/client/theme-default/components/VPNavBarSearch.vue
index 6a52d7972a3e..8ff9017c1f9c 100644
--- a/src/client/theme-default/components/VPNavBarSearch.vue
+++ b/src/client/theme-default/components/VPNavBarSearch.vue
@@ -219,6 +219,8 @@ function load() {
 }
 
 .DocSearch-Button .DocSearch-Button-Keys {
+  /*rtl:ignore*/
+  direction: ltr;
   display: none;
   min-width: auto;
 }
@@ -234,9 +236,11 @@ function load() {
   display: block;
   margin: 2px 0 0 0;
   border: 1px solid var(--vp-c-divider);
+  /*rtl:begin:ignore*/
   border-right: none;
   border-radius: 4px 0 0 4px;
   padding-left: 6px;
+  /*rtl:end:ignore*/
   min-width: 0;
   width: auto;
   height: 22px;
@@ -248,11 +252,13 @@ function load() {
 }
 
 .DocSearch-Button .DocSearch-Button-Key + .DocSearch-Button-Key {
+  /*rtl:begin:ignore*/
   border-right: 1px solid var(--vp-c-divider);
   border-left: none;
   border-radius: 0 4px 4px 0;
   padding-left: 2px;
   padding-right: 6px;
+  /*rtl:end:ignore*/
 }
 
 .DocSearch-Button .DocSearch-Button-Key:first-child {
diff --git a/src/client/theme-default/components/VPNavScreen.vue b/src/client/theme-default/components/VPNavScreen.vue
index 1d4d58baa4c6..57dfdc0563bd 100644
--- a/src/client/theme-default/components/VPNavScreen.vue
+++ b/src/client/theme-default/components/VPNavScreen.vue
@@ -44,8 +44,10 @@ function unlockBodyScroll() {
 .VPNavScreen {
   position: fixed;
   top: calc(var(--vp-nav-height-mobile) + var(--vp-layout-top-height, 0px));
+  /*rtl:ignore*/
   right: 0;
   bottom: 0;
+  /*rtl:ignore*/
   left: 0;
   padding: 0 32px;
   width: 100%;
diff --git a/src/client/theme-default/components/VPNavScreenMenuGroup.vue b/src/client/theme-default/components/VPNavScreenMenuGroup.vue
index d66e02c9aca3..e2882c466da3 100644
--- a/src/client/theme-default/components/VPNavScreenMenuGroup.vue
+++ b/src/client/theme-default/components/VPNavScreenMenuGroup.vue
@@ -79,6 +79,7 @@ function toggle() {
 }
 
 .VPNavScreenMenuGroup.open .button-icon {
+  /*rtl:ignore*/
   transform: rotate(45deg);
 }
 
diff --git a/src/client/theme-default/components/VPSwitch.vue b/src/client/theme-default/components/VPSwitch.vue
index a9a5988f7bcb..4fcc800d64fc 100644
--- a/src/client/theme-default/components/VPSwitch.vue
+++ b/src/client/theme-default/components/VPSwitch.vue
@@ -28,6 +28,7 @@
 .check {
   position: absolute;
   top: 1px;
+  /*rtl:ignore*/
   left: 1px;
   width: 18px;
   height: 18px;
diff --git a/src/client/theme-default/components/VPSwitchAppearance.vue b/src/client/theme-default/components/VPSwitchAppearance.vue
index 9613f1eb83da..2f3b4fcb394a 100644
--- a/src/client/theme-default/components/VPSwitchAppearance.vue
+++ b/src/client/theme-default/components/VPSwitchAppearance.vue
@@ -104,6 +104,7 @@ watch(checked, (newIsDark) => {
 }
 
 .dark .VPSwitchAppearance :deep(.check) {
+  /*rtl:ignore*/
   transform: translateX(18px);
 }
 </style>
diff --git a/src/client/theme-default/styles/components/vp-doc.css b/src/client/theme-default/styles/components/vp-doc.css
index 7220523c7389..aff2af57eebd 100644
--- a/src/client/theme-default/styles/components/vp-doc.css
+++ b/src/client/theme-default/styles/components/vp-doc.css
@@ -286,6 +286,9 @@
 
 .vp-doc [class*='language-'] pre,
 .vp-doc [class*='language-'] code {
+  /*rtl:ignore*/
+  direction: ltr;
+  /*rtl:ignore*/
   text-align: left;
   white-space: pre;
   word-spacing: normal;
@@ -386,6 +389,7 @@
 }
 
 .vp-doc div[class*='language-'].line-numbers-mode {
+  /*rtl:ignore*/
   padding-left: 32px;
 }
 
@@ -393,8 +397,10 @@
   position: absolute;
   top: 0;
   bottom: 0;
+  /*rtl:ignore*/
   left: 0;
   z-index: 3;
+  /*rtl:ignore*/
   border-right: 1px solid var(--vp-c-divider-dark-2);
   padding-top: 16px;
   width: 32px;
@@ -407,8 +413,11 @@
 }
 
 .vp-doc [class*='language-'] > button.copy {
+  /*rtl:ignore*/
+  direction: ltr;
   position: absolute;
   top: 8px;
+  /*rtl:ignore*/
   right: 8px;
   z-index: 3;
   display: block;
@@ -438,6 +447,7 @@
 
 .vp-doc [class*='language-'] > button.copy.copied,
 .vp-doc [class*='language-'] > button.copy:hover.copied {
+  /*rtl:ignore*/
   border-radius: 0 4px 4px 0;
   background-color: var(--vp-code-copy-code-hover-bg);
   background-image: var(--vp-icon-copied);
@@ -446,8 +456,10 @@
 .vp-doc [class*='language-'] > button.copy.copied::before,
 .vp-doc [class*='language-'] > button.copy:hover.copied::before {
   position: relative;
+  /*rtl:ignore*/
   left: -65px;
   display: block;
+  /*rtl:ignore*/
   border-radius: 4px 0 0 4px;
   padding-top: 8px;
   width: 64px;
@@ -464,6 +476,7 @@
 .vp-doc [class*='language-'] > span.lang {
   position: absolute;
   top: 6px;
+  /*rtl:ignore*/
   right: 12px;
   z-index: 2;
   font-size: 12px;

From 0075b27c2e91c6ea4051e3a68819fd41b61c1ce6 Mon Sep 17 00:00:00 2001
From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Date: Wed, 7 Dec 2022 10:52:13 +0530
Subject: [PATCH 12/24] feat: multilingual search

---
 .../components/VPAlgoliaSearchBox.vue         |  50 +++---
 .../components/VPNavBarSearch.vue             |  36 ++++-
 types/default-theme.d.ts                      |  17 +--
 types/docsearch.d.ts                          | 143 ++++++++++++++++++
 4 files changed, 208 insertions(+), 38 deletions(-)
 create mode 100644 types/docsearch.d.ts

diff --git a/src/client/theme-default/components/VPAlgoliaSearchBox.vue b/src/client/theme-default/components/VPAlgoliaSearchBox.vue
index db2226a125c2..ffc5144f548f 100644
--- a/src/client/theme-default/components/VPAlgoliaSearchBox.vue
+++ b/src/client/theme-default/components/VPAlgoliaSearchBox.vue
@@ -1,7 +1,7 @@
 <script setup lang="ts">
 import type { DefaultTheme } from 'vitepress/theme'
 import docsearch from '@docsearch/js'
-import { onMounted } from 'vue'
+import { onMounted, watch } from 'vue'
 import { useRouter, useRoute, useData } from 'vitepress'
 
 const props = defineProps<{
@@ -10,35 +10,37 @@ const props = defineProps<{
 
 const router = useRouter()
 const route = useRoute()
-const { site } = useData()
+const { site, localeIndex, lang } = useData()
 
-onMounted(() => {
-  initialize(props.algolia)
-  setTimeout(poll, 16)
-})
-
-function poll() {
-  // programmatically open the search box after initialize
-  const e = new Event('keydown') as any
-
-  e.key = 'k'
-  e.metaKey = true
-
-  window.dispatchEvent(e)
+const docsearch$ = docsearch.default ?? docsearch
+type DocSearchProps = Parameters<typeof docsearch$>[0]
 
-  setTimeout(() => {
-    if (!document.querySelector('.DocSearch-Modal')) {
-      poll()
+onMounted(update)
+watch(localeIndex, update)
+
+function update() {
+  const options = {
+    ...props.algolia,
+    ...props.algolia.locales?.[localeIndex.value]
+  }
+  const rawFacetFilters = options.searchParameters?.facetFilters ?? []
+  const facetFilters = [
+    ...(Array.isArray(rawFacetFilters)
+      ? rawFacetFilters
+      : [rawFacetFilters]
+    ).filter((f) => !f.startsWith('lang:')),
+    `lang:${lang.value}`
+  ]
+  initialize({
+    ...options,
+    searchParameters: {
+      ...options.searchParameters,
+      facetFilters
     }
-  }, 16)
+  })
 }
 
-const docsearch$ = docsearch.default ?? docsearch
-type DocSearchProps = Parameters<typeof docsearch$>[0]
-
 function initialize(userOptions: DefaultTheme.AlgoliaSearchOptions) {
-  // note: multi-lang search support is removed since the theme
-  // doesn't support multiple locales as of now.
   const options = Object.assign<{}, {}, DocSearchProps>({}, userOptions, {
     container: '#docsearch',
 
diff --git a/src/client/theme-default/components/VPNavBarSearch.vue b/src/client/theme-default/components/VPNavBarSearch.vue
index 8ff9017c1f9c..f1c043bf20ff 100644
--- a/src/client/theme-default/components/VPNavBarSearch.vue
+++ b/src/client/theme-default/components/VPNavBarSearch.vue
@@ -1,13 +1,19 @@
 <script lang="ts" setup>
 import '@docsearch/css'
-import { defineAsyncComponent, ref, onMounted, onUnmounted } from 'vue'
+import {
+  computed,
+  defineAsyncComponent,
+  onMounted,
+  onUnmounted,
+  ref
+} from 'vue'
 import { useData } from 'vitepress'
 
 const VPAlgoliaSearchBox = __ALGOLIA__
   ? defineAsyncComponent(() => import('./VPAlgoliaSearchBox.vue'))
   : () => null
 
-const { theme } = useData()
+const { theme, localeIndex } = useData()
 
 // to avoid loading the docsearch js upfront (which is more than 1/3 of the
 // payload), we delay initializing it until the user has actually clicked or
@@ -15,6 +21,13 @@ const { theme } = useData()
 const loaded = ref(false)
 
 const metaKey = ref(`'Meta'`)
+const buttonText = computed(
+  () =>
+    theme.value.algolia?.locales?.[localeIndex.value]?.translations?.button
+      ?.buttonText ||
+    theme.value.algolia?.translations?.button?.buttonText ||
+    'Search'
+)
 
 onMounted(() => {
   if (!theme.value.algolia) {
@@ -46,8 +59,25 @@ onMounted(() => {
 function load() {
   if (!loaded.value) {
     loaded.value = true
+    setTimeout(poll, 16)
   }
 }
+
+function poll() {
+  // programmatically open the search box after initialize
+  const e = new Event('keydown') as any
+
+  e.key = 'k'
+  e.metaKey = true
+
+  window.dispatchEvent(e)
+
+  setTimeout(() => {
+    if (!document.querySelector('.DocSearch-Modal')) {
+      poll()
+    }
+  }, 16)
+}
 </script>
 
 <template>
@@ -76,7 +106,7 @@ function load() {
               stroke-linejoin="round"
             />
           </svg>
-          <span class="DocSearch-Button-Placeholder">{{ theme.algolia?.buttonText || 'Search' }}</span>
+          <span class="DocSearch-Button-Placeholder">{{ buttonText }}</span>
         </span>
         <span class="DocSearch-Button-Keys">
           <kbd class="DocSearch-Button-Key"></kbd>
diff --git a/types/default-theme.d.ts b/types/default-theme.d.ts
index db4de593c596..8ad093ba5c2f 100644
--- a/types/default-theme.d.ts
+++ b/types/default-theme.d.ts
@@ -1,3 +1,5 @@
+import { DocSearchProps } from './docsearch.js'
+
 export namespace DefaultTheme {
   export interface Config {
     /**
@@ -124,7 +126,7 @@ export namespace DefaultTheme {
     activeMatch?: string
   }
 
-  // image -----------------------------------------------------------------------
+  // image ---------------------------------------------------------------------
 
   export type ThemeableImage =
     | Image
@@ -243,21 +245,14 @@ export namespace DefaultTheme {
     label?: string
   }
 
-  // algolia ------------------------------------------------------------------
+  // algolia -------------------------------------------------------------------
 
   /**
    * The Algolia search options. Partially copied from
    * `@docsearch/react/dist/esm/DocSearch.d.ts`
    */
-  export interface AlgoliaSearchOptions {
-    appId: string
-    apiKey: string
-    indexName: string
-    placeholder?: string
-    searchParameters?: any
-    disableUserPersonalization?: boolean
-    initialQuery?: string
-    buttonText?: string
+  export interface AlgoliaSearchOptions extends DocSearchProps {
+    locales?: Record<string, Partial<DocSearchProps>>
   }
 
   // carbon ads ----------------------------------------------------------------
diff --git a/types/docsearch.d.ts b/types/docsearch.d.ts
new file mode 100644
index 000000000000..4f0b558856d3
--- /dev/null
+++ b/types/docsearch.d.ts
@@ -0,0 +1,143 @@
+export interface DocSearchProps {
+  appId: string
+  apiKey: string
+  indexName: string
+  placeholder?: string
+  searchParameters?: SearchOptions
+  disableUserPersonalization?: boolean
+  initialQuery?: string
+  translations?: DocSearchTranslations
+}
+
+export interface SearchOptions {
+  query?: string
+  similarQuery?: string
+  facetFilters?: string | string[]
+  optionalFilters?: string | string[]
+  numericFilters?: string | string[]
+  tagFilters?: string | string[]
+  sumOrFiltersScores?: boolean
+  filters?: string
+  page?: number
+  hitsPerPage?: number
+  offset?: number
+  length?: number
+  attributesToHighlight?: string[]
+  attributesToSnippet?: string[]
+  attributesToRetrieve?: string[]
+  highlightPreTag?: string
+  highlightPostTag?: string
+  snippetEllipsisText?: string
+  restrictHighlightAndSnippetArrays?: boolean
+  facets?: string[]
+  maxValuesPerFacet?: number
+  facetingAfterDistinct?: boolean
+  minWordSizefor1Typo?: number
+  minWordSizefor2Typos?: number
+  allowTyposOnNumericTokens?: boolean
+  disableTypoToleranceOnAttributes?: string[]
+  queryType?: 'prefixLast' | 'prefixAll' | 'prefixNone'
+  removeWordsIfNoResults?: 'none' | 'lastWords' | 'firstWords' | 'allOptional'
+  advancedSyntax?: boolean
+  advancedSyntaxFeatures?: ('exactPhrase' | 'excludeWords')[]
+  optionalWords?: string | string[]
+  disableExactOnAttributes?: string[]
+  exactOnSingleWordQuery?: 'attribute' | 'none' | 'word'
+  alternativesAsExact?: (
+    | 'ignorePlurals'
+    | 'singleWordSynonym'
+    | 'multiWordsSynonym'
+  )[]
+  enableRules?: boolean
+  ruleContexts?: string[]
+  distinct?: boolean | number
+  analytics?: boolean
+  analyticsTags?: string[]
+  synonyms?: boolean
+  replaceSynonymsInHighlight?: boolean
+  minProximity?: number
+  responseFields?: string[]
+  maxFacetHits?: number
+  percentileComputation?: boolean
+  clickAnalytics?: boolean
+  personalizationImpact?: number
+  enablePersonalization?: boolean
+  restrictSearchableAttributes?: string[]
+  sortFacetValuesBy?: 'count' | 'alpha'
+  typoTolerance?: boolean | 'min' | 'strict'
+  aroundLatLng?: string
+  aroundLatLngViaIP?: boolean
+  aroundRadius?: number | 'all'
+  aroundPrecision?: number | { from: number; value: number }[]
+  minimumAroundRadius?: number
+  insideBoundingBox?: number[][]
+  insidePolygon?: number[][]
+  ignorePlurals?: boolean | string[]
+  removeStopWords?: boolean | string[]
+  naturalLanguages?: string[]
+  getRankingInfo?: boolean
+  userToken?: string
+  enableABTest?: boolean
+  decompoundQuery?: boolean
+  relevancyStrictness?: number
+}
+
+export interface DocSearchTranslations {
+  button?: ButtonTranslations
+  modal?: ModalTranslations
+}
+
+export interface ButtonTranslations {
+  buttonText?: string
+  buttonAriaLabel?: string
+}
+
+export interface ModalTranslations extends ScreenStateTranslations {
+  searchBox?: SearchBoxTranslations
+  footer?: FooterTranslations
+}
+
+export interface ScreenStateTranslations {
+  errorScreen?: ErrorScreenTranslations
+  startScreen?: StartScreenTranslations
+  noResultsScreen?: NoResultsScreenTranslations
+}
+
+export interface SearchBoxTranslations {
+  resetButtonTitle?: string
+  resetButtonAriaLabel?: string
+  cancelButtonText?: string
+  cancelButtonAriaLabel?: string
+}
+
+export interface FooterTranslations {
+  selectText?: string
+  selectKeyAriaLabel?: string
+  navigateText?: string
+  navigateUpKeyAriaLabel?: string
+  navigateDownKeyAriaLabel?: string
+  closeText?: string
+  closeKeyAriaLabel?: string
+  searchByText?: string
+}
+
+export interface ErrorScreenTranslations {
+  titleText?: string
+  helpText?: string
+}
+
+export interface StartScreenTranslations {
+  recentSearchesTitle?: string
+  noRecentSearchesText?: string
+  saveRecentSearchButtonTitle?: string
+  removeRecentSearchButtonTitle?: string
+  favoriteSearchesTitle?: string
+  removeFavoriteSearchButtonTitle?: string
+}
+
+export interface NoResultsScreenTranslations {
+  noResultsText?: string
+  suggestedQueryText?: string
+  reportMissingResultsText?: string
+  reportMissingResultsLinkText?: string
+}

From 5322e4bb010b9edc2c0ba7610dcf2106ecfe8737 Mon Sep 17 00:00:00 2001
From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Date: Wed, 7 Dec 2022 13:28:05 +0530
Subject: [PATCH 13/24] revert: useData type to any

---
 src/client/app/data.ts | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/src/client/app/data.ts b/src/client/app/data.ts
index 33bbc2a8d4ad..1443a1efb460 100644
--- a/src/client/app/data.ts
+++ b/src/client/app/data.ts
@@ -13,8 +13,7 @@ import {
   PageData,
   SiteData,
   resolveSiteDataByRoute,
-  createTitle,
-  DefaultTheme
+  createTitle
 } from '../shared.js'
 
 export const dataSymbol: InjectionKey<VitePressData> = Symbol()
@@ -70,7 +69,7 @@ export function initData(route: Route): VitePressData {
   }
 }
 
-export function useData<T = DefaultTheme.Config>(): VitePressData<T> {
+export function useData<T = any>(): VitePressData<T> {
   const data = inject(dataSymbol)
   if (!data) {
     throw new Error('vitepress data not properly injected in app')

From 907de58b5dbfc662ef6e2d4a68d46b8e2af0ba0a Mon Sep 17 00:00:00 2001
From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Date: Wed, 7 Dec 2022 14:57:25 +0530
Subject: [PATCH 14/24] use typed useData in theme-default

---
 src/client/theme-default/Layout.vue                           | 3 ++-
 src/client/theme-default/NotFound.vue                         | 3 ++-
 src/client/theme-default/components/VPAlgoliaSearchBox.vue    | 3 ++-
 src/client/theme-default/components/VPContent.vue             | 3 ++-
 src/client/theme-default/components/VPDocAside.vue            | 2 +-
 src/client/theme-default/components/VPDocAsideOutline.vue     | 2 +-
 src/client/theme-default/components/VPDocFooter.vue           | 2 +-
 .../theme-default/components/VPDocFooterLastUpdated.vue       | 2 +-
 src/client/theme-default/components/VPFooter.vue              | 2 +-
 src/client/theme-default/components/VPHomeFeatures.vue        | 2 +-
 src/client/theme-default/components/VPHomeHero.vue            | 2 +-
 src/client/theme-default/components/VPLocalNav.vue            | 2 +-
 src/client/theme-default/components/VPMenuLink.vue            | 2 +-
 src/client/theme-default/components/VPNavBarAppearance.vue    | 2 +-
 src/client/theme-default/components/VPNavBarExtra.vue         | 2 +-
 src/client/theme-default/components/VPNavBarMenu.vue          | 2 +-
 src/client/theme-default/components/VPNavBarMenuGroup.vue     | 2 +-
 src/client/theme-default/components/VPNavBarMenuLink.vue      | 2 +-
 src/client/theme-default/components/VPNavBarSearch.vue        | 2 +-
 src/client/theme-default/components/VPNavBarSocialLinks.vue   | 2 +-
 src/client/theme-default/components/VPNavBarTitle.vue         | 2 +-
 src/client/theme-default/components/VPNavScreenAppearance.vue | 2 +-
 src/client/theme-default/components/VPNavScreenMenu.vue       | 2 +-
 .../theme-default/components/VPNavScreenSocialLinks.vue       | 2 +-
 src/client/theme-default/components/VPSidebarGroup.vue        | 2 +-
 src/client/theme-default/components/VPSidebarLink.vue         | 2 +-
 src/client/theme-default/components/VPSwitchAppearance.vue    | 2 +-
 src/client/theme-default/composables/data.ts                  | 4 ++++
 src/client/theme-default/composables/edit-link.ts             | 2 +-
 src/client/theme-default/composables/langs.ts                 | 2 +-
 src/client/theme-default/composables/prev-next.ts             | 2 +-
 src/client/theme-default/composables/sidebar.ts               | 3 ++-
 src/client/theme-default/support/utils.ts                     | 3 ++-
 33 files changed, 42 insertions(+), 32 deletions(-)
 create mode 100644 src/client/theme-default/composables/data.ts

diff --git a/src/client/theme-default/Layout.vue b/src/client/theme-default/Layout.vue
index ffaf6b9cdb39..de980310d7d1 100644
--- a/src/client/theme-default/Layout.vue
+++ b/src/client/theme-default/Layout.vue
@@ -1,6 +1,7 @@
 <script setup lang="ts">
 import { provide, watch } from 'vue'
-import { useData, useRoute } from 'vitepress'
+import { useRoute } from 'vitepress'
+import { useData } from './composables/data.js'
 import { useSidebar, useCloseSidebarOnEscape } from './composables/sidebar.js'
 import VPSkipLink from './components/VPSkipLink.vue'
 import VPBackdrop from './components/VPBackdrop.vue'
diff --git a/src/client/theme-default/NotFound.vue b/src/client/theme-default/NotFound.vue
index cf9525fb8dd0..badae1afc9e6 100644
--- a/src/client/theme-default/NotFound.vue
+++ b/src/client/theme-default/NotFound.vue
@@ -1,6 +1,7 @@
 <script setup lang="ts">
 import { onMounted, ref } from 'vue'
-import { useData, withBase } from 'vitepress'
+import { withBase } from 'vitepress'
+import { useData } from './composables/data.js'
 import { useLangs } from './composables/langs.js'
 
 const { site } = useData()
diff --git a/src/client/theme-default/components/VPAlgoliaSearchBox.vue b/src/client/theme-default/components/VPAlgoliaSearchBox.vue
index ffc5144f548f..63681dbdc694 100644
--- a/src/client/theme-default/components/VPAlgoliaSearchBox.vue
+++ b/src/client/theme-default/components/VPAlgoliaSearchBox.vue
@@ -2,7 +2,8 @@
 import type { DefaultTheme } from 'vitepress/theme'
 import docsearch from '@docsearch/js'
 import { onMounted, watch } from 'vue'
-import { useRouter, useRoute, useData } from 'vitepress'
+import { useRouter, useRoute } from 'vitepress'
+import { useData } from '../composables/data.js'
 
 const props = defineProps<{
   algolia: DefaultTheme.AlgoliaSearchOptions
diff --git a/src/client/theme-default/components/VPContent.vue b/src/client/theme-default/components/VPContent.vue
index 8f4e1e1ece03..ecd32b02c331 100644
--- a/src/client/theme-default/components/VPContent.vue
+++ b/src/client/theme-default/components/VPContent.vue
@@ -1,5 +1,6 @@
 <script setup lang="ts">
-import { useRoute, useData } from 'vitepress'
+import { useRoute } from 'vitepress'
+import { useData } from '../composables/data.js'
 import { useSidebar } from '../composables/sidebar.js'
 import VPPage from './VPPage.vue'
 import VPHome from './VPHome.vue'
diff --git a/src/client/theme-default/components/VPDocAside.vue b/src/client/theme-default/components/VPDocAside.vue
index 10bbbb429533..f886107fb585 100644
--- a/src/client/theme-default/components/VPDocAside.vue
+++ b/src/client/theme-default/components/VPDocAside.vue
@@ -1,6 +1,6 @@
 <script setup lang="ts">
 import { defineAsyncComponent } from 'vue'
-import { useData } from 'vitepress'
+import { useData } from '../composables/data.js'
 import VPDocAsideOutline from './VPDocAsideOutline.vue'
 
 const { theme } = useData()
diff --git a/src/client/theme-default/components/VPDocAsideOutline.vue b/src/client/theme-default/components/VPDocAsideOutline.vue
index 197436ba7c2a..584eacad71c2 100644
--- a/src/client/theme-default/components/VPDocAsideOutline.vue
+++ b/src/client/theme-default/components/VPDocAsideOutline.vue
@@ -1,7 +1,7 @@
 <script setup lang="ts">
-import { useData } from 'vitepress'
 import type { DefaultTheme } from 'vitepress/theme'
 import { computed, inject, ref, type Ref } from 'vue'
+import { useData } from '../composables/data.js'
 import {
   getHeaders,
   useActiveAnchor,
diff --git a/src/client/theme-default/components/VPDocFooter.vue b/src/client/theme-default/components/VPDocFooter.vue
index 4fe6d5904264..0ec8916acd71 100644
--- a/src/client/theme-default/components/VPDocFooter.vue
+++ b/src/client/theme-default/components/VPDocFooter.vue
@@ -1,6 +1,6 @@
 <script setup lang="ts">
 import { computed } from 'vue'
-import { useData } from 'vitepress'
+import { useData } from '../composables/data.js'
 import { normalizeLink } from '../support/utils.js'
 import { useEditLink } from '../composables/edit-link.js'
 import { usePrevNext } from '../composables/prev-next.js'
diff --git a/src/client/theme-default/components/VPDocFooterLastUpdated.vue b/src/client/theme-default/components/VPDocFooterLastUpdated.vue
index f9b45f433b56..595c2871d1b5 100644
--- a/src/client/theme-default/components/VPDocFooterLastUpdated.vue
+++ b/src/client/theme-default/components/VPDocFooterLastUpdated.vue
@@ -1,6 +1,6 @@
 <script setup lang="ts">
 import { ref, computed, watchEffect, onMounted } from 'vue'
-import { useData } from 'vitepress'
+import { useData } from '../composables/data.js'
 
 const { theme, page } = useData()
 
diff --git a/src/client/theme-default/components/VPFooter.vue b/src/client/theme-default/components/VPFooter.vue
index 381b82e89c35..16e8c6025635 100644
--- a/src/client/theme-default/components/VPFooter.vue
+++ b/src/client/theme-default/components/VPFooter.vue
@@ -1,5 +1,5 @@
 <script setup lang="ts">
-import { useData } from 'vitepress'
+import { useData } from '../composables/data.js'
 import { useSidebar } from '../composables/sidebar.js'
 
 const { theme } = useData()
diff --git a/src/client/theme-default/components/VPHomeFeatures.vue b/src/client/theme-default/components/VPHomeFeatures.vue
index ee593fc14db7..ac8367b134dd 100644
--- a/src/client/theme-default/components/VPHomeFeatures.vue
+++ b/src/client/theme-default/components/VPHomeFeatures.vue
@@ -1,5 +1,5 @@
 <script setup lang="ts">
-import { useData } from 'vitepress'
+import { useData } from '../composables/data.js'
 import VPFeatures from './VPFeatures.vue'
 
 const { frontmatter: fm } = useData()
diff --git a/src/client/theme-default/components/VPHomeHero.vue b/src/client/theme-default/components/VPHomeHero.vue
index 9aa64aa9dda0..ffcfd922b35d 100644
--- a/src/client/theme-default/components/VPHomeHero.vue
+++ b/src/client/theme-default/components/VPHomeHero.vue
@@ -1,5 +1,5 @@
 <script setup lang="ts">
-import { useData } from 'vitepress'
+import { useData } from '../composables/data.js'
 import VPHero from './VPHero.vue'
 
 const { frontmatter: fm } = useData()
diff --git a/src/client/theme-default/components/VPLocalNav.vue b/src/client/theme-default/components/VPLocalNav.vue
index 6e4729eb4008..e4400deb4e00 100644
--- a/src/client/theme-default/components/VPLocalNav.vue
+++ b/src/client/theme-default/components/VPLocalNav.vue
@@ -1,5 +1,5 @@
 <script lang="ts" setup>
-import { useData } from 'vitepress'
+import { useData } from '../composables/data.js'
 import { useSidebar } from '../composables/sidebar.js'
 import VPIconAlignLeft from './icons/VPIconAlignLeft.vue'
 
diff --git a/src/client/theme-default/components/VPMenuLink.vue b/src/client/theme-default/components/VPMenuLink.vue
index 6a55e795d22d..bf118efc8c61 100644
--- a/src/client/theme-default/components/VPMenuLink.vue
+++ b/src/client/theme-default/components/VPMenuLink.vue
@@ -1,5 +1,5 @@
 <script lang="ts" setup>
-import { useData } from 'vitepress'
+import { useData } from '../composables/data.js'
 import { isActive } from '../support/utils.js'
 import VPLink from './VPLink.vue'
 
diff --git a/src/client/theme-default/components/VPNavBarAppearance.vue b/src/client/theme-default/components/VPNavBarAppearance.vue
index 62c8d9fc565a..a5947b292464 100644
--- a/src/client/theme-default/components/VPNavBarAppearance.vue
+++ b/src/client/theme-default/components/VPNavBarAppearance.vue
@@ -1,5 +1,5 @@
 <script lang="ts" setup>
-import { useData } from 'vitepress'
+import { useData } from '../composables/data.js'
 import VPSwitchAppearance from './VPSwitchAppearance.vue'
 
 const { site } = useData()
diff --git a/src/client/theme-default/components/VPNavBarExtra.vue b/src/client/theme-default/components/VPNavBarExtra.vue
index 65b6dda5264c..6b1289276f94 100644
--- a/src/client/theme-default/components/VPNavBarExtra.vue
+++ b/src/client/theme-default/components/VPNavBarExtra.vue
@@ -1,10 +1,10 @@
 <script lang="ts" setup>
-import { useData } from 'vitepress'
 import { computed } from 'vue'
 import VPFlyout from './VPFlyout.vue'
 import VPMenuLink from './VPMenuLink.vue'
 import VPSwitchAppearance from './VPSwitchAppearance.vue'
 import VPSocialLinks from './VPSocialLinks.vue'
+import { useData } from '../composables/data.js'
 import { useLangs } from '../composables/langs.js'
 
 const { site, theme } = useData()
diff --git a/src/client/theme-default/components/VPNavBarMenu.vue b/src/client/theme-default/components/VPNavBarMenu.vue
index c8fb6df2f445..0f3699657d9a 100644
--- a/src/client/theme-default/components/VPNavBarMenu.vue
+++ b/src/client/theme-default/components/VPNavBarMenu.vue
@@ -1,5 +1,5 @@
 <script lang="ts" setup>
-import { useData } from 'vitepress'
+import { useData } from '../composables/data.js'
 import VPNavBarMenuLink from './VPNavBarMenuLink.vue'
 import VPNavBarMenuGroup from './VPNavBarMenuGroup.vue'
 
diff --git a/src/client/theme-default/components/VPNavBarMenuGroup.vue b/src/client/theme-default/components/VPNavBarMenuGroup.vue
index d5b86ea62c81..9bb759c3e45a 100644
--- a/src/client/theme-default/components/VPNavBarMenuGroup.vue
+++ b/src/client/theme-default/components/VPNavBarMenuGroup.vue
@@ -1,6 +1,6 @@
 <script lang="ts" setup>
-import { useData } from 'vitepress'
 import type { DefaultTheme } from 'vitepress/theme'
+import { useData } from '../composables/data.js'
 import { isActive } from '../support/utils.js'
 import VPFlyout from './VPFlyout.vue'
 
diff --git a/src/client/theme-default/components/VPNavBarMenuLink.vue b/src/client/theme-default/components/VPNavBarMenuLink.vue
index f2a15e01b22c..796b33e9bc7b 100644
--- a/src/client/theme-default/components/VPNavBarMenuLink.vue
+++ b/src/client/theme-default/components/VPNavBarMenuLink.vue
@@ -1,6 +1,6 @@
 <script lang="ts" setup>
 import type { DefaultTheme } from 'vitepress/theme'
-import { useData } from 'vitepress'
+import { useData } from '../composables/data.js'
 import { isActive } from '../support/utils.js'
 import VPLink from './VPLink.vue'
 
diff --git a/src/client/theme-default/components/VPNavBarSearch.vue b/src/client/theme-default/components/VPNavBarSearch.vue
index f1c043bf20ff..4f4b4f67ef39 100644
--- a/src/client/theme-default/components/VPNavBarSearch.vue
+++ b/src/client/theme-default/components/VPNavBarSearch.vue
@@ -7,7 +7,7 @@ import {
   onUnmounted,
   ref
 } from 'vue'
-import { useData } from 'vitepress'
+import { useData } from '../composables/data.js'
 
 const VPAlgoliaSearchBox = __ALGOLIA__
   ? defineAsyncComponent(() => import('./VPAlgoliaSearchBox.vue'))
diff --git a/src/client/theme-default/components/VPNavBarSocialLinks.vue b/src/client/theme-default/components/VPNavBarSocialLinks.vue
index e5dfd6303b52..d9388a27ce39 100644
--- a/src/client/theme-default/components/VPNavBarSocialLinks.vue
+++ b/src/client/theme-default/components/VPNavBarSocialLinks.vue
@@ -1,5 +1,5 @@
 <script lang="ts" setup>
-import { useData } from 'vitepress'
+import { useData } from '../composables/data.js'
 import VPSocialLinks from './VPSocialLinks.vue'
 
 const { theme } = useData()
diff --git a/src/client/theme-default/components/VPNavBarTitle.vue b/src/client/theme-default/components/VPNavBarTitle.vue
index 89c2d9468552..e78d30705f54 100644
--- a/src/client/theme-default/components/VPNavBarTitle.vue
+++ b/src/client/theme-default/components/VPNavBarTitle.vue
@@ -1,5 +1,5 @@
 <script setup lang="ts">
-import { useData } from 'vitepress'
+import { useData } from '../composables/data.js'
 import { useSidebar } from '../composables/sidebar.js'
 import { useLangs } from '../composables/langs.js'
 import { normalizeLink } from '../support/utils.js'
diff --git a/src/client/theme-default/components/VPNavScreenAppearance.vue b/src/client/theme-default/components/VPNavScreenAppearance.vue
index 1bff9cad923d..3d4fb836e006 100644
--- a/src/client/theme-default/components/VPNavScreenAppearance.vue
+++ b/src/client/theme-default/components/VPNavScreenAppearance.vue
@@ -1,5 +1,5 @@
 <script lang="ts" setup>
-import { useData } from 'vitepress'
+import { useData } from '../composables/data.js'
 import VPSwitchAppearance from './VPSwitchAppearance.vue'
 
 const { site, theme } = useData()
diff --git a/src/client/theme-default/components/VPNavScreenMenu.vue b/src/client/theme-default/components/VPNavScreenMenu.vue
index d75ef61da895..d285f1e547e5 100644
--- a/src/client/theme-default/components/VPNavScreenMenu.vue
+++ b/src/client/theme-default/components/VPNavScreenMenu.vue
@@ -1,5 +1,5 @@
 <script lang="ts" setup>
-import { useData } from 'vitepress'
+import { useData } from '../composables/data.js'
 import VPNavScreenMenuLink from './VPNavScreenMenuLink.vue'
 import VPNavScreenMenuGroup from './VPNavScreenMenuGroup.vue'
 
diff --git a/src/client/theme-default/components/VPNavScreenSocialLinks.vue b/src/client/theme-default/components/VPNavScreenSocialLinks.vue
index 45f4d31845d4..bcd59aa3b6ef 100644
--- a/src/client/theme-default/components/VPNavScreenSocialLinks.vue
+++ b/src/client/theme-default/components/VPNavScreenSocialLinks.vue
@@ -1,5 +1,5 @@
 <script lang="ts" setup>
-import { useData } from 'vitepress'
+import { useData } from '../composables/data.js'
 import VPSocialLinks from './VPSocialLinks.vue'
 
 const { theme } = useData()
diff --git a/src/client/theme-default/components/VPSidebarGroup.vue b/src/client/theme-default/components/VPSidebarGroup.vue
index 701453733f05..b53802b75390 100644
--- a/src/client/theme-default/components/VPSidebarGroup.vue
+++ b/src/client/theme-default/components/VPSidebarGroup.vue
@@ -1,7 +1,7 @@
 <script lang="ts" setup>
 import type { DefaultTheme } from 'vitepress/theme'
 import { ref, watchEffect } from 'vue'
-import { useData } from 'vitepress'
+import { useData } from '../composables/data.js'
 import { isActive } from '../support/utils.js'
 import VPIconPlusSquare from './icons/VPIconPlusSquare.vue'
 import VPIconMinusSquare from './icons/VPIconMinusSquare.vue'
diff --git a/src/client/theme-default/components/VPSidebarLink.vue b/src/client/theme-default/components/VPSidebarLink.vue
index 00775138dd96..036b78b1ddab 100644
--- a/src/client/theme-default/components/VPSidebarLink.vue
+++ b/src/client/theme-default/components/VPSidebarLink.vue
@@ -1,7 +1,7 @@
 <script lang="ts" setup>
 import type { DefaultTheme } from 'vitepress/theme'
 import { computed, inject } from 'vue'
-import { useData } from 'vitepress'
+import { useData } from '../composables/data.js'
 import { isActive } from '../support/utils.js'
 import VPLink from './VPLink.vue'
 
diff --git a/src/client/theme-default/components/VPSwitchAppearance.vue b/src/client/theme-default/components/VPSwitchAppearance.vue
index 2f3b4fcb394a..c734b1396e53 100644
--- a/src/client/theme-default/components/VPSwitchAppearance.vue
+++ b/src/client/theme-default/components/VPSwitchAppearance.vue
@@ -1,6 +1,6 @@
 <script lang="ts" setup>
 import { ref, onMounted, watch } from 'vue'
-import { useData } from 'vitepress'
+import { useData } from '../composables/data.js'
 import { APPEARANCE_KEY } from '../../shared.js'
 import VPSwitch from './VPSwitch.vue'
 import VPIconSun from './icons/VPIconSun.vue'
diff --git a/src/client/theme-default/composables/data.ts b/src/client/theme-default/composables/data.ts
new file mode 100644
index 000000000000..513b2c532d96
--- /dev/null
+++ b/src/client/theme-default/composables/data.ts
@@ -0,0 +1,4 @@
+import { useData as useData$ } from 'vitepress'
+import type { DefaultTheme } from 'vitepress/theme'
+
+export const useData: typeof useData$<DefaultTheme.Config> = useData$
diff --git a/src/client/theme-default/composables/edit-link.ts b/src/client/theme-default/composables/edit-link.ts
index 0e76b8931b04..929b645ae4a6 100644
--- a/src/client/theme-default/composables/edit-link.ts
+++ b/src/client/theme-default/composables/edit-link.ts
@@ -1,5 +1,5 @@
 import { computed } from 'vue'
-import { useData } from 'vitepress'
+import { useData } from './data.js'
 
 export function useEditLink() {
   const { theme, page } = useData()
diff --git a/src/client/theme-default/composables/langs.ts b/src/client/theme-default/composables/langs.ts
index 9140cb244449..cad9dbf25419 100644
--- a/src/client/theme-default/composables/langs.ts
+++ b/src/client/theme-default/composables/langs.ts
@@ -1,5 +1,5 @@
 import { computed } from 'vue'
-import { useData } from 'vitepress'
+import { useData } from './data.js'
 
 export function useLangs(removeCurrent = true) {
   const { site, localeIndex } = useData()
diff --git a/src/client/theme-default/composables/prev-next.ts b/src/client/theme-default/composables/prev-next.ts
index 2633a617eecf..91ca6cd70ef0 100644
--- a/src/client/theme-default/composables/prev-next.ts
+++ b/src/client/theme-default/composables/prev-next.ts
@@ -1,5 +1,5 @@
 import { computed } from 'vue'
-import { useData } from 'vitepress'
+import { useData } from './data.js'
 import { isActive } from '../support/utils.js'
 import { getSidebar, getFlatSideBarLinks } from '../support/sidebar.js'
 
diff --git a/src/client/theme-default/composables/sidebar.ts b/src/client/theme-default/composables/sidebar.ts
index 7cb1b05509fd..b2e8836385f2 100644
--- a/src/client/theme-default/composables/sidebar.ts
+++ b/src/client/theme-default/composables/sidebar.ts
@@ -1,5 +1,6 @@
 import { computed, onMounted, onUnmounted, Ref, ref, watchEffect } from 'vue'
-import { useData, useRoute } from 'vitepress'
+import { useRoute } from 'vitepress'
+import { useData } from './data.js'
 import { getSidebar } from '../support/sidebar.js'
 
 export function useSidebar() {
diff --git a/src/client/theme-default/support/utils.ts b/src/client/theme-default/support/utils.ts
index fea9d463dd87..ccd167e569ce 100644
--- a/src/client/theme-default/support/utils.ts
+++ b/src/client/theme-default/support/utils.ts
@@ -1,4 +1,5 @@
-import { withBase, useData } from 'vitepress'
+import { withBase } from 'vitepress'
+import { useData } from '../composables/data.js'
 import { isExternal } from '../../shared.js'
 
 export { isExternal, isActive } from '../../shared.js'

From f77b51f978991bf3f6481ab70508933159423773 Mon Sep 17 00:00:00 2001
From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Date: Wed, 21 Dec 2022 13:50:45 +0530
Subject: [PATCH 15/24] feat: go to corresponding link on changing locale

---
 src/client/theme-default/NotFound.vue         |  6 ++--
 .../components/VPNavBarExtra.vue              |  2 +-
 .../components/VPNavBarTranslations.vue       |  2 +-
 .../components/VPNavScreenTranslations.vue    |  2 +-
 src/client/theme-default/composables/langs.ts | 32 +++++++++++++++++--
 5 files changed, 35 insertions(+), 9 deletions(-)

diff --git a/src/client/theme-default/NotFound.vue b/src/client/theme-default/NotFound.vue
index badae1afc9e6..cc26ad2ece87 100644
--- a/src/client/theme-default/NotFound.vue
+++ b/src/client/theme-default/NotFound.vue
@@ -5,7 +5,7 @@ import { useData } from './composables/data.js'
 import { useLangs } from './composables/langs.js'
 
 const { site } = useData()
-const { localeLinks } = useLangs(false)
+const { localeLinks } = useLangs({ removeCurrent: false })
 
 const root = ref('/')
 onMounted(() => {
@@ -67,7 +67,7 @@ onMounted(() => {
   margin: 24px auto 18px;
   width: 64px;
   height: 1px;
-  background-color: var(--vp-c-divider)
+  background-color: var(--vp-c-divider);
 }
 
 .quote {
@@ -90,7 +90,7 @@ onMounted(() => {
   font-size: 14px;
   font-weight: 500;
   color: var(--vp-c-brand);
-  transition: border-color 0.25s, color .25s;
+  transition: border-color 0.25s, color 0.25s;
 }
 
 .link:hover {
diff --git a/src/client/theme-default/components/VPNavBarExtra.vue b/src/client/theme-default/components/VPNavBarExtra.vue
index 6b1289276f94..08cc3b6114a2 100644
--- a/src/client/theme-default/components/VPNavBarExtra.vue
+++ b/src/client/theme-default/components/VPNavBarExtra.vue
@@ -8,7 +8,7 @@ import { useData } from '../composables/data.js'
 import { useLangs } from '../composables/langs.js'
 
 const { site, theme } = useData()
-const { localeLinks, currentLang } = useLangs()
+const { localeLinks, currentLang } = useLangs({ correspondingLink: true })
 
 const hasExtraContent = computed(
   () =>
diff --git a/src/client/theme-default/components/VPNavBarTranslations.vue b/src/client/theme-default/components/VPNavBarTranslations.vue
index d271a8cc6ed6..a184d2840ae6 100644
--- a/src/client/theme-default/components/VPNavBarTranslations.vue
+++ b/src/client/theme-default/components/VPNavBarTranslations.vue
@@ -4,7 +4,7 @@ import VPFlyout from './VPFlyout.vue'
 import VPMenuLink from './VPMenuLink.vue'
 import { useLangs } from '../composables/langs.js'
 
-const { localeLinks, currentLang } = useLangs()
+const { localeLinks, currentLang } = useLangs({ correspondingLink: true })
 </script>
 
 <template>
diff --git a/src/client/theme-default/components/VPNavScreenTranslations.vue b/src/client/theme-default/components/VPNavScreenTranslations.vue
index 6ab174fb9a57..5c9cfe25f2b4 100644
--- a/src/client/theme-default/components/VPNavScreenTranslations.vue
+++ b/src/client/theme-default/components/VPNavScreenTranslations.vue
@@ -5,7 +5,7 @@ import VPIconLanguages from './icons/VPIconLanguages.vue'
 import { useLangs } from '../composables/langs.js'
 import VPLink from './VPLink.vue'
 
-const { localeLinks, currentLang } = useLangs()
+const { localeLinks, currentLang } = useLangs({ correspondingLink: true })
 const isOpen = ref(false)
 
 function toggle() {
diff --git a/src/client/theme-default/composables/langs.ts b/src/client/theme-default/composables/langs.ts
index cad9dbf25419..c540a7d55190 100644
--- a/src/client/theme-default/composables/langs.ts
+++ b/src/client/theme-default/composables/langs.ts
@@ -1,8 +1,12 @@
 import { computed } from 'vue'
 import { useData } from './data.js'
+import { ensureStartingSlash } from '../support/utils.js'
 
-export function useLangs(removeCurrent = true) {
-  const { site, localeIndex } = useData()
+export function useLangs({
+  removeCurrent = true,
+  correspondingLink = false
+} = {}) {
+  const { site, localeIndex, page } = useData()
   const currentLang = computed(() => ({
     label: site.value.locales[localeIndex.value]?.label,
     link:
@@ -16,10 +20,32 @@ export function useLangs(removeCurrent = true) {
         ? []
         : {
             text: value.label,
-            link: value.link || (key === 'root' ? '/' : `/${key}/`)
+            link: normalizeLink(
+              value.link || (key === 'root' ? '/' : `/${key}/`),
+              correspondingLink,
+              page.value.relativePath,
+              site.value.cleanUrls === 'disabled'
+            )
           }
     )
   )
 
   return { localeLinks, currentLang }
 }
+
+function normalizeLink(
+  link: string,
+  addPath: boolean,
+  path: string,
+  addExt: boolean
+) {
+  return addPath
+    ? link.replace(/\/$/, '') +
+        ensureStartingSlash(
+          path
+            .replace(/^.*?\//, '/')
+            .replace(/\/index.md$/, '/')
+            .replace(/\.md$/, addExt ? '.html' : '')
+        )
+    : link
+}

From e842edfe3e2e7787e440adc71b3712d4e2d89c53 Mon Sep 17 00:00:00 2001
From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Date: Wed, 21 Dec 2022 14:07:16 +0530
Subject: [PATCH 16/24] feat: allow disabling automatic locale link mapping

---
 src/client/theme-default/composables/langs.ts | 4 ++--
 types/default-theme.d.ts                      | 7 +++++++
 2 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/src/client/theme-default/composables/langs.ts b/src/client/theme-default/composables/langs.ts
index c540a7d55190..af5ed0acf9b5 100644
--- a/src/client/theme-default/composables/langs.ts
+++ b/src/client/theme-default/composables/langs.ts
@@ -6,7 +6,7 @@ export function useLangs({
   removeCurrent = true,
   correspondingLink = false
 } = {}) {
-  const { site, localeIndex, page } = useData()
+  const { site, localeIndex, page, theme } = useData()
   const currentLang = computed(() => ({
     label: site.value.locales[localeIndex.value]?.label,
     link:
@@ -22,7 +22,7 @@ export function useLangs({
             text: value.label,
             link: normalizeLink(
               value.link || (key === 'root' ? '/' : `/${key}/`),
-              correspondingLink,
+              theme.value.i18nRouting !== false && correspondingLink,
               page.value.relativePath,
               site.value.cleanUrls === 'disabled'
             )
diff --git a/types/default-theme.d.ts b/types/default-theme.d.ts
index 8ad093ba5c2f..c31224ef736d 100644
--- a/types/default-theme.d.ts
+++ b/types/default-theme.d.ts
@@ -93,6 +93,13 @@ export namespace DefaultTheme {
      * The carbon ads options. Leave it undefined to disable the ads feature.
      */
     carbonAds?: CarbonAdsOptions
+
+    /**
+     * Changing locale when current url is `/foo` will redirect to `/locale/foo`.
+     *
+     * @default true
+     */
+    i18nRouting?: boolean
   }
 
   // nav -----------------------------------------------------------------------

From f1850321fe8486ee9430f4adbb7636b4f35ea490 Mon Sep 17 00:00:00 2001
From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Date: Wed, 21 Dec 2022 14:26:50 +0530
Subject: [PATCH 17/24] fix i18n routing for root locale

---
 src/client/theme-default/composables/langs.ts | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/src/client/theme-default/composables/langs.ts b/src/client/theme-default/composables/langs.ts
index af5ed0acf9b5..fc0b0cd17b76 100644
--- a/src/client/theme-default/composables/langs.ts
+++ b/src/client/theme-default/composables/langs.ts
@@ -23,7 +23,7 @@ export function useLangs({
             link: normalizeLink(
               value.link || (key === 'root' ? '/' : `/${key}/`),
               theme.value.i18nRouting !== false && correspondingLink,
-              page.value.relativePath,
+              page.value.relativePath.slice(currentLang.value.link.length - 1),
               site.value.cleanUrls === 'disabled'
             )
           }
@@ -43,7 +43,6 @@ function normalizeLink(
     ? link.replace(/\/$/, '') +
         ensureStartingSlash(
           path
-            .replace(/^.*?\//, '/')
             .replace(/\/index.md$/, '/')
             .replace(/\.md$/, addExt ? '.html' : '')
         )

From 43067082f3ed375c086d3610c10f258e8a1d7708 Mon Sep 17 00:00:00 2001
From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Date: Wed, 4 Jan 2023 13:44:37 +0530
Subject: [PATCH 18/24] fix merge

---
 src/client/theme-default/components/VPCarbonAds.vue | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/client/theme-default/components/VPCarbonAds.vue b/src/client/theme-default/components/VPCarbonAds.vue
index 9ef1ca5ecc17..ff9938b938ac 100644
--- a/src/client/theme-default/components/VPCarbonAds.vue
+++ b/src/client/theme-default/components/VPCarbonAds.vue
@@ -2,7 +2,7 @@
 import type { DefaultTheme } from 'vitepress/theme'
 import { ref, watch, onMounted } from 'vue'
 import { useAside } from '../composables/aside.js'
-import { useData } from './composables/data.js'
+import { useData } from '../composables/data.js'
 
 const { page } = useData()
 const props = defineProps<{

From 857d97e5605d0ecf08df9578e8d6e0a6f570ca8c Mon Sep 17 00:00:00 2001
From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Date: Wed, 4 Jan 2023 13:48:20 +0530
Subject: [PATCH 19/24] fix?

---
 src/node/build/render.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/node/build/render.ts b/src/node/build/render.ts
index 9519ab04d9d1..c03fbecc7788 100644
--- a/src/node/build/render.ts
+++ b/src/node/build/render.ts
@@ -15,7 +15,7 @@ import {
   sanitizeFileName
 } from '../shared'
 import { slash } from '../utils/slash'
-import { type SiteConfig } from '../config'
+import type { SiteConfig } from '../config'
 
 export async function renderPage(
   render: (path: string) => Promise<string>,

From 3d0ce5dea553c54de3fdf934016d50b95636f7dc Mon Sep 17 00:00:00 2001
From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Date: Thu, 12 Jan 2023 20:56:28 +0530
Subject: [PATCH 20/24] fix ts

---
 rollup.config.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/rollup.config.ts b/rollup.config.ts
index 543eebefaa33..66b69ee07fe5 100644
--- a/rollup.config.ts
+++ b/rollup.config.ts
@@ -2,7 +2,7 @@ import { promises as fs } from 'fs'
 import { builtinModules, createRequire } from 'module'
 import { resolve } from 'path'
 import { fileURLToPath } from 'url'
-import { RollupOptions, defineConfig } from 'rollup'
+import { type RollupOptions, defineConfig } from 'rollup'
 import { nodeResolve } from '@rollup/plugin-node-resolve'
 import commonjs from '@rollup/plugin-commonjs'
 import esbuild from 'rollup-plugin-esbuild'

From 12c9a1f9577f8d5fd8d29f79bd456f8a72f9b5cc Mon Sep 17 00:00:00 2001
From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Date: Fri, 13 Jan 2023 15:58:50 +0530
Subject: [PATCH 21/24] fix locale change on home page

---
 src/client/theme-default/composables/langs.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/client/theme-default/composables/langs.ts b/src/client/theme-default/composables/langs.ts
index fc0b0cd17b76..d80ccb265325 100644
--- a/src/client/theme-default/composables/langs.ts
+++ b/src/client/theme-default/composables/langs.ts
@@ -43,7 +43,7 @@ function normalizeLink(
     ? link.replace(/\/$/, '') +
         ensureStartingSlash(
           path
-            .replace(/\/index.md$/, '/')
+            .replace(/(^|\/)?index.md$/, '$1')
             .replace(/\.md$/, addExt ? '.html' : '')
         )
     : link

From b2ac950aa345a684691431b18dbb55a9ac5b48d3 Mon Sep 17 00:00:00 2001
From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Date: Fri, 13 Jan 2023 19:59:27 +0530
Subject: [PATCH 22/24] docs

---
 docs/.vitepress/config.ts    |  3 +-
 docs/config/theme-configs.md |  6 +++
 docs/guide/api.md            | 11 ++--
 docs/guide/i18n.md           | 99 ++++++++++++++++++++++++++++++++++++
 docs/guide/theme-search.md   | 84 +++++++++++++++++++++++++++++-
 5 files changed, 196 insertions(+), 7 deletions(-)
 create mode 100644 docs/guide/i18n.md

diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
index 4a2c9e6aeffb..e6c9a964b3da 100644
--- a/docs/.vitepress/config.ts
+++ b/docs/.vitepress/config.ts
@@ -84,7 +84,8 @@ function sidebarGuide() {
         { text: 'What is VitePress?', link: '/guide/what-is-vitepress' },
         { text: 'Getting Started', link: '/guide/getting-started' },
         { text: 'Configuration', link: '/guide/configuration' },
-        { text: 'Deploying', link: '/guide/deploying' }
+        { text: 'Deploying', link: '/guide/deploying' },
+        { text: 'Internationalization', link: '/guide/i18n' }
       ]
     },
     {
diff --git a/docs/config/theme-configs.md b/docs/config/theme-configs.md
index e3eb1d05e2be..a92ad2c15324 100644
--- a/docs/config/theme-configs.md
+++ b/docs/config/theme-configs.md
@@ -19,6 +19,12 @@ export default {
 
 Here it describes the settings for the VitePress default theme. If you're using a custom theme created by others, these settings may not have any effect, or might behave differently.
 
+## i18nRouting
+
+- Type: `boolean`
+
+Changing locale to say `zh` will change the URL from `/foo` (or `/en/foo/`) to `/zh/foo`. You can disable this behavior by setting `themeConfig.i18nRouting` to `false`.
+
 ## logo
 
 - Type: `ThemeableImage`
diff --git a/docs/guide/api.md b/docs/guide/api.md
index 44fbba27f86a..3c04271b04ca 100644
--- a/docs/guide/api.md
+++ b/docs/guide/api.md
@@ -11,16 +11,17 @@ Methods that start with `use*` indicates that it is a [Vue 3 Composition API](ht
 Returns page-specific data. The returned object has the following type:
 
 ```ts
-interface VitePressData {
-  site: Ref<SiteData>
+interface VitePressData<T = any> {
+  site: Ref<SiteData<T>>
   page: Ref<PageData>
-  theme: Ref<any> // themeConfig from .vitepress/config.js
+  theme: Ref<T> // themeConfig from .vitepress/config.js
   frontmatter: Ref<PageData['frontmatter']>
-  lang: Ref<string>
   title: Ref<string>
   description: Ref<string>
-  localePath: Ref<string>
+  lang: Ref<string>
   isDark: Ref<boolean>
+  dir: Ref<string>
+  localeIndex: Ref<string>
 }
 ```
 
diff --git a/docs/guide/i18n.md b/docs/guide/i18n.md
new file mode 100644
index 000000000000..01f9495b5290
--- /dev/null
+++ b/docs/guide/i18n.md
@@ -0,0 +1,99 @@
+# Internationalization
+
+To use the built-in i18n features, one needs to create a directory structure as follows:
+
+```
+docs/
+├─ es/
+│  ├─ foo.md
+├─ fr/
+│  ├─ foo.md
+├─ foo.md
+```
+
+Then in `docs/.vitepress/config.ts`:
+
+```ts
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+  // shared properties and other top-level stuff...
+
+  locales: {
+    root: {
+      label: 'English',
+      lang: 'en'
+    },
+    fr: {
+      label: 'French',
+      lang: 'fr', // optional, will be added  as `lang` attribute on `html` tag
+      link: '/fr/guide' // default /fr/ -- shows on navbar translations menu, can be external
+
+      // other locale specific properties...
+    }
+  }
+})
+```
+
+The following properties can be overridden for each locale (including root):
+
+```ts
+interface LocaleSpecificConfig<ThemeConfig = any> {
+  lang?: string
+  dir?: string
+  title?: string
+  titleTemplate?: string | boolean
+  description?: string
+  head?: HeadConfig[] // will be merged with existing head entries, duplicate meta tags are automatically removed
+  themeConfig?: ThemeConfig // will be shallow merged, common stuff can be put in top-level themeConfig entry
+}
+```
+
+Refer [`DefaultTheme.Config`](https://github.com/vuejs/vitepress/blob/main/types/default-theme.d.ts) interface for details on customizing the placeholder texts of the default theme. Don't override `themeConfig.algolia` or `themeConfig.carbonAds` at locale-level. Refer [Algolia docs](./theme-search#i18n) for using multilingual search.
+
+**Pro tip:** Config file can be stored at `docs/.vitepress/config/index.ts` too. It might help you organize stuff by creating a configuration file per locale and then merge and export them from `index.ts`.
+
+## Separate directory for each locale
+
+The following is a perfectly fine structure:
+
+```
+docs/
+├─ en/
+│  ├─ foo.md
+├─ es/
+│  ├─ foo.md
+├─ fr/
+   ├─ foo.md
+```
+
+However, VitePress won't redirect `/` to `/en/` by default. You'll need to configure your server for that. For example, on Netlify, you can add a `docs/public/_redirects` file like this:
+
+```
+/*  /es/:splat  302  Language=es
+/*  /fr/:splat  302  Language=fr
+/*  /en/:splat  302
+```
+
+**Pro tip:** If using the above approach, you can use `nf_lang` cookie to persist user's language choice. A very basic way to do this is register a watcher inside the [setup](./theme-introduction#using-a-custom-theme) function of custom theme:
+
+```ts
+// docs/.vitepress/theme/index.ts
+import DefaultTheme from 'vitepress/theme'
+
+export default {
+  ...DefaultTheme,
+  setup() {
+    const { lang } = useData()
+    watchEffect(() => {
+      if (inBrowser) {
+        document.cookie = `nf_lang=${lang.value}; expires=Mon, 1 Jan 2024 00:00:00 UTC; path=/`
+      }
+    })
+  }
+}
+```
+
+## RTL Support (Experimental)
+
+For RTL support, specify `dir: 'rtl'` in config and use some RTLCSS PostCSS plugin like <https://github.com/MohammadYounes/rtlcss>, <https://github.com/vkalinichev/postcss-rtl> or <https://github.com/elchininet/postcss-rtlcss>. You'll need to configure your PostCSS plugin to use `:where([dir="ltr"])` and `:where([dir="rtl"])` as prefixes to prevent CSS specificity issues.
diff --git a/docs/guide/theme-search.md b/docs/guide/theme-search.md
index f33d3b35cccd..26b77a29cb54 100644
--- a/docs/guide/theme-search.md
+++ b/docs/guide/theme-search.md
@@ -1,3 +1,85 @@
 # Search
 
-Documentation coming soon...
+VitePress supports searching your docs site using [Algolia DocSearch](https://docsearch.algolia.com/docs/what-is-docsearch). Refer their getting started guide. In your `.vitepress/config.ts` you'll need to provide at least the following to make it work:
+
+```ts
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+  themeConfig: {
+    algolia: {
+      appId: '...',
+      apiKey: '...',
+      indexName: '...'
+    }
+  }
+})
+```
+
+If you are not eligible for DocSearch, you might wanna use some community plugins like <https://github.com/emersonbottero/vitepress-plugin-search> or explore some custom solutions on [this GitHub thread](https://github.com/vuejs/vitepress/issues/670).
+
+## i18n
+
+You can use a config like this to use multilingual search:
+
+```ts
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+  // ...
+  themeConfig: {
+    // ...
+
+    algolia: {
+      appId: '...',
+      apiKey: '...',
+      indexName: '...',
+      locales: {
+        zh: {
+          placeholder: '搜索文档',
+          translations: {
+            button: {
+              buttonText: '搜索文档',
+              buttonAriaLabel: '搜索文档'
+            },
+            modal: {
+              searchBox: {
+                resetButtonTitle: '清除查询条件',
+                resetButtonAriaLabel: '清除查询条件',
+                cancelButtonText: '取消',
+                cancelButtonAriaLabel: '取消'
+              },
+              startScreen: {
+                recentSearchesTitle: '搜索历史',
+                noRecentSearchesText: '没有搜索历史',
+                saveRecentSearchButtonTitle: '保存至搜索历史',
+                removeRecentSearchButtonTitle: '从搜索历史中移除',
+                favoriteSearchesTitle: '收藏',
+                removeFavoriteSearchButtonTitle: '从收藏中移除'
+              },
+              errorScreen: {
+                titleText: '无法获取结果',
+                helpText: '你可能需要检查你的网络连接'
+              },
+              footer: {
+                selectText: '选择',
+                navigateText: '切换',
+                closeText: '关闭',
+                searchByText: '搜索提供者'
+              },
+              noResultsScreen: {
+                noResultsText: '无法找到相关结果',
+                suggestedQueryText: '你可以尝试查询',
+                reportMissingResultsText: '你认为该查询应该有结果？',
+                reportMissingResultsLinkText: '点击反馈'
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+})
+```
+
+[These options](https://github.com/vuejs/vitepress/blob/main/types/docsearch.d.ts) can be overridden. Refer official Algolia docs to learn more about them.

From 5559bb387700edd8952b088e2fc0f27c6f51547f Mon Sep 17 00:00:00 2001
From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Date: Tue, 17 Jan 2023 14:38:48 +0530
Subject: [PATCH 23/24] fix conflicts

---
 src/node/build/render.ts | 16 ++++++++--------
 src/node/config.ts       | 28 ++++++++++++++--------------
 src/shared/shared.ts     | 14 +++++++-------
 3 files changed, 29 insertions(+), 29 deletions(-)

diff --git a/src/node/build/render.ts b/src/node/build/render.ts
index c03fbecc7788..6392a6597034 100644
--- a/src/node/build/render.ts
+++ b/src/node/build/render.ts
@@ -1,21 +1,21 @@
+import escape from 'escape-html'
 import fs from 'fs-extra'
 import path from 'path'
+import type { OutputAsset, OutputChunk, RollupOutput } from 'rollup'
 import { pathToFileURL } from 'url'
-import escape from 'escape-html'
 import { normalizePath, transformWithEsbuild } from 'vite'
-import type { RollupOutput, OutputChunk, OutputAsset } from 'rollup'
+import type { SiteConfig } from '../config'
 import {
-  type HeadConfig,
-  type PageData,
   createTitle,
-  notFoundPageData,
-  mergeHead,
   EXTERNAL_URL_RE,
+  mergeHead,
+  notFoundPageData,
   resolveSiteDataByRoute,
-  sanitizeFileName
+  sanitizeFileName,
+  type HeadConfig,
+  type PageData
 } from '../shared'
 import { slash } from '../utils/slash'
-import type { SiteConfig } from '../config'
 
 export async function renderPage(
   render: (path: string) => Promise<string>,
diff --git a/src/node/config.ts b/src/node/config.ts
index 0daebcb61cf9..4eb2f5b83b5a 100644
--- a/src/node/config.ts
+++ b/src/node/config.ts
@@ -1,28 +1,28 @@
-import path from 'path'
+import type { Options as VuePluginOptions } from '@vitejs/plugin-vue'
+import _debug from 'debug'
+import fg from 'fast-glob'
 import fs from 'fs-extra'
+import path from 'path'
 import c from 'picocolors'
-import fg from 'fast-glob'
 import {
-  normalizePath,
-  type UserConfig as ViteConfig,
+  loadConfigFromFile,
   mergeConfig as mergeViteConfig,
-  loadConfigFromFile
+  normalizePath,
+  type UserConfig as ViteConfig
 } from 'vite'
-import type { Options as VuePluginOptions } from '@vitejs/plugin-vue'
+import { DEFAULT_THEME_PATH } from './alias'
+import type { MarkdownOptions } from './markdown/markdown'
 import {
-  type SiteData,
+  APPEARANCE_KEY,
+  type Awaitable,
+  type CleanUrlsMode,
+  type DefaultTheme,
   type HeadConfig,
   type LocaleConfig,
   type LocaleSpecificConfig,
-  type DefaultTheme,
-  APPEARANCE_KEY,
-  type CleanUrlsMode,
   type PageData,
-  type Awaitable
+  type SiteData
 } from './shared'
-import { DEFAULT_THEME_PATH } from './alias'
-import type { MarkdownOptions } from './markdown/markdown'
-import _debug from 'debug'
 
 const debug = _debug('vitepress:config')
 
diff --git a/src/shared/shared.ts b/src/shared/shared.ts
index 3786452b46cb..f24385fc20c7 100644
--- a/src/shared/shared.ts
+++ b/src/shared/shared.ts
@@ -1,16 +1,16 @@
-import type { SiteData, PageData, HeadConfig } from '../../types/shared.js'
+import type { HeadConfig, PageData, SiteData } from '../../types/shared.js'
 
 export type {
-  SiteData,
-  PageData,
+  Awaitable,
+  CleanUrlsMode,
+  DefaultTheme,
   HeadConfig,
+  Header,
   LocaleConfig,
   LocaleSpecificConfig,
-  Header,
-  DefaultTheme,
+  PageData,
   PageDataPayload,
-  CleanUrlsMode,
-  Awaitable
+  SiteData
 } from '../../types/shared.js'
 
 export const EXTERNAL_URL_RE = /^[a-z]+:/i

From 7ca1b9f546c3a64e49a7b5c598bc90f9822891f7 Mon Sep 17 00:00:00 2001
From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Date: Tue, 17 Jan 2023 14:46:19 +0530
Subject: [PATCH 24/24] fix conflicts

---
 src/node/build/render.ts | 1 +
 src/node/config.ts       | 4 ++--
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/node/build/render.ts b/src/node/build/render.ts
index f761f03a9da9..2b55e2919cba 100644
--- a/src/node/build/render.ts
+++ b/src/node/build/render.ts
@@ -10,6 +10,7 @@ import {
   EXTERNAL_URL_RE,
   mergeHead,
   notFoundPageData,
+  resolveSiteDataByRoute,
   sanitizeFileName,
   type HeadConfig,
   type PageData,
diff --git a/src/node/config.ts b/src/node/config.ts
index bbb18b58eea5..b1c8e90ab4ae 100644
--- a/src/node/config.ts
+++ b/src/node/config.ts
@@ -10,7 +10,6 @@ import {
   normalizePath,
   type UserConfig as ViteConfig
 } from 'vite'
-import type { SSGContext } from '../../types/shared'
 import { DEFAULT_THEME_PATH } from './alias'
 import type { MarkdownOptions } from './markdown/markdown'
 import {
@@ -22,7 +21,8 @@ import {
   type LocaleConfig,
   type LocaleSpecificConfig,
   type PageData,
-  type SiteData
+  type SiteData,
+  type SSGContext
 } from './shared'
 
 const debug = _debug('vitepress:config')