vitepress 0.22.2 → 1.0.0-draft.1

package/types/default-theme.d.ts

@@ -1,127 +1,158 @@
 export namespace DefaultTheme {
   export interface Config {
-    logo?: string
-    nav?: NavItem[] | false
-    sidebar?: SideBarConfig | MultiSideBarConfig
-
     /**
-     * GitHub repository following the format <user>/<project>.
+     * The logo file of the site.
      *
-     * @example `"vuejs/vue-next"`
+     * @example '/logo.svg'
      */
-    repo?: string
+    logo?: string
 
     /**
-     * Customize the header label. Defaults to GitHub/Gitlab/Bitbucket
-     * depending on the provided repo.
-     *
-     * @example `"Contribute!"`
+     * The nav items.
      */
-    repoLabel?: string
+    nav?: NavItem[]
 
     /**
-     * If your docs are in a different repository from your main project.
-     *
-     * @example `"vuejs/docs-next"`
+     * The sidebar items.
      */
-    docsRepo?: string
+    sidebar?: Sidebar
 
     /**
-     * If your docs are not at the root of the repo.
-     *
-     * @example `"docs"`
+     * Info for the edit link. If it's undefined, the edit link feature will
+     * be disabled.
      */
-    docsDir?: string
+    editLink?: EditLink
 
     /**
-     * If your docs are in a different branch. Defaults to `master`.
-     *
-     * @example `"next"`
+     * 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.
      */
-    docsBranch?: string
+    socialLinks?: SocialLink[]
 
     /**
-     * Enable links to edit pages at the bottom of the page.
+     * Adds locale menu to the nav. This option should be used when you have
+     * your translated sites outside of the project.
      */
-    editLinks?: boolean
+    localeLinks?: LocaleLinks
 
     /**
-     * Custom text for edit link. Defaults to "Edit this page".
+     * The algolia options. Leave it undefined to disable the search feature.
      */
-    editLinkText?: string
+    algolia?: AlgoliaSearchOptions
 
     /**
-     * Show last updated time at the bottom of the page. Defaults to `false`.
-     * If given a string, it will be displayed as a prefix (default value:
-     * "Last Updated").
+     * The carbon ads options. Leave it undefined to disable the ads feature.
      */
-    lastUpdated?: string | boolean
-
-    prevLinks?: boolean
-    nextLinks?: boolean
-
-    locales?: Record<string, LocaleConfig & Omit<Config, 'locales'>>
-
-    algolia?: AlgoliaSearchOptions
-
-    carbonAds?: {
-      carbon: string
-      custom?: string
-      placement: string
-    }
+    carbonAds?: CarbonAdsOptions
   }
 
-  // navbar --------------------------------------------------------------------
+  // nav -----------------------------------------------------------------------
 
   export type NavItem = NavItemWithLink | NavItemWithChildren
 
-  export interface NavItemBase {
+  export type NavItemWithLink = {
     text: string
-    target?: string
-    rel?: string
-    ariaLabel?: string
-    activeMatch?: string
-  }
-
-  export interface NavItemWithLink extends NavItemBase {
     link: string
+
+    /**
+     * `activeMatch` is expected to be a regex string. We can't use actual
+     * RegExp object here because it isn't serializable
+     */
+    activeMatch?: string
   }
 
-  export interface NavItemWithChildren extends NavItemBase {
+  export interface NavItemWithChildren {
+    text?: string
     items: NavItemWithLink[]
   }
 
   // sidebar -------------------------------------------------------------------
 
-  export type SideBarConfig = SideBarItem[] | 'auto' | false
+  export type Sidebar = SidebarGroup[] | SidebarMulti
 
-  export interface MultiSideBarConfig {
-    [path: string]: SideBarConfig
+  export interface SidebarMulti {
+    [path: string]: SidebarGroup[]
   }
 
-  export type SideBarItem = SideBarLink | SideBarGroup
+  export interface SidebarGroup {
+    text: string
+    items: SidebarItem[]
+  }
 
-  export interface SideBarLink {
+  export interface SidebarItem {
     text: string
     link: string
   }
 
-  export interface SideBarGroup {
-    text: string
-    link?: string
+  // edit link -----------------------------------------------------------------
+
+  export interface EditLink {
+    /**
+     * Repo of the site.
+     *
+     * @example 'vuejs/docs'
+     */
+    repo: string
+
+    /**
+     * Branch of the repo.
+     *
+     * @default 'main'
+     */
+    branch?: string
 
     /**
-     * @default false
+     * If your docs are not at the root of the repo.
+     *
+     * @example 'docs'
      */
-    collapsable?: boolean
+    dir?: string
 
-    children: SideBarItem[]
+    /**
+     * Custom text for edit link.
+     *
+     * @default 'Edit this page'
+     */
+    text?: string
   }
 
-  // algolia  ------------------------------------------------------------------
-  // partially copied from @docsearch/react/dist/esm/DocSearch.d.ts
+  // social link ---------------------------------------------------------------
+
+  export interface SocialLink {
+    icon: SocialLinkIcon
+    link: string
+  }
+
+  export type SocialLinkIcon =
+    | 'discord'
+    | 'facebook'
+    | 'github'
+    | 'instagram'
+    | 'linkedin'
+    | 'slack'
+    | 'twitter'
+    | 'youtube'
+
+  // locales -------------------------------------------------------------------
+
+  export interface LocaleLinks {
+    text: string
+    items: LocaleLink[]
+  }
+
+  export interface LocaleLink {
+    text: string
+    link: string
+  }
+
+  // algolia ------------------------------------------------------------------
+
+  /**
+   * The Algolia search options. Partially copied from
+   * `@docsearch/react/dist/esm/DocSearch.d.ts`
+   */
   export interface AlgoliaSearchOptions {
-    appId?: string
+    appId: string
     apiKey: string
     indexName: string
     placeholder?: string
@@ -130,17 +161,11 @@ export namespace DefaultTheme {
     initialQuery?: string
   }
 
-  // locales -------------------------------------------------------------------
+  // carbon ads ----------------------------------------------------------------
 
-  export interface LocaleConfig {
-    /**
-     * Text for the language dropdown.
-     */
-    selectText?: string
-
-    /**
-     * Label for this locale in the language dropdown.
-     */
-    label?: string
+  export interface CarbonAdsOptions {
+    carbon: string
+    custom?: string
+    placement: string
   }
 }

package/dist/client/theme-default/components/AlgoliaSearchBox.vue

@@ -1,195 +0,0 @@
-<script setup lang="ts">
-import '@docsearch/css'
-import docsearch from '@docsearch/js'
-import { useRoute, useRouter, useData } from 'vitepress'
-import { getCurrentInstance, onMounted, watch } from 'vue'
-import type { DefaultTheme } from '../config'
-import type { DocSearchHit } from '@docsearch/react/dist/esm/types'
-
-const props = defineProps<{
-  options: DefaultTheme.AlgoliaSearchOptions
-  multilang?: boolean
-}>()
-
-const vm = getCurrentInstance()
-const route = useRoute()
-const router = useRouter()
-
-watch(
-  () => props.options,
-  (value) => {
-    update(value)
-  }
-)
-
-onMounted(() => {
-  initialize(props.options)
-})
-
-function isSpecialClick(event: MouseEvent) {
-  return (
-    event.button === 1 ||
-    event.altKey ||
-    event.ctrlKey ||
-    event.metaKey ||
-    event.shiftKey
-  )
-}
-
-function getRelativePath(absoluteUrl: string) {
-  const { pathname, hash } = new URL(absoluteUrl)
-
-  return pathname + hash
-}
-
-function update(options: any) {
-  if (vm && vm.vnode.el) {
-    vm.vnode.el.innerHTML =
-      '<div class="algolia-search-box" id="docsearch"></div>'
-    initialize(options)
-  }
-}
-
-const { lang } = useData()
-
-// if the user has multiple locales, the search results should be filtered
-// based on the language
-const facetFilters: string[] = props.multilang
-  ? ['lang:' + lang.value]
-  : []
-
-if (props.options.searchParameters?.facetFilters) {
-  facetFilters.push(...props.options.searchParameters.facetFilters)
-}
-
-watch(
-  lang,
-  (newLang, oldLang) => {
-    const index = facetFilters.findIndex(
-      (filter) => filter === 'lang:' + oldLang
-    )
-    if (index > -1) {
-      facetFilters.splice(index, 1, 'lang:' + newLang)
-    }
-  }
-)
-
-function initialize(userOptions: any) {
-  docsearch(
-    Object.assign({}, userOptions, {
-      container: '#docsearch',
-
-      searchParameters: Object.assign({}, userOptions.searchParameters, {
-        // pass a custom lang facetFilter to allow multiple language search
-        // https://github.com/algolia/docsearch-configs/pull/3942
-        facetFilters
-      }),
-
-      navigator: {
-        navigate: ({ itemUrl }: { itemUrl: string }) => {
-          const { pathname: hitPathname } = new URL(
-            window.location.origin + itemUrl
-          )
-
-          // Router doesn't handle same-page navigation so we use the native
-          // browser location API for anchor navigation
-          if (route.path === hitPathname) {
-            window.location.assign(window.location.origin + itemUrl)
-          } else {
-            router.go(itemUrl)
-          }
-        }
-      },
-
-      transformItems: (items: DocSearchHit[]) => {
-        return items.map((item) => {
-          return Object.assign({}, item, {
-            url: getRelativePath(item.url)
-          })
-        })
-      },
-
-      hitComponent: ({
-        hit,
-        children
-      }: {
-        hit: DocSearchHit
-        children: any
-      }) => {
-        const relativeHit = hit.url.startsWith('http')
-          ? getRelativePath(hit.url as string)
-          : hit.url
-
-        return {
-          type: 'a',
-          ref: undefined,
-          constructor: undefined,
-          key: undefined,
-          props: {
-            href: hit.url,
-            onClick: (event: MouseEvent) => {
-              if (isSpecialClick(event)) {
-                return
-              }
-
-              // we rely on the native link scrolling when user is already on
-              // the right anchor because Router doesn't support duplicated
-              // history entries
-              if (route.path === relativeHit) {
-                return
-              }
-
-              // if the hits goes to another page, we prevent the native link
-              // behavior to leverage the Router loading feature
-              if (route.path !== relativeHit) {
-                event.preventDefault()
-              }
-
-              router.go(relativeHit)
-            },
-            children
-          },
-          __v: null
-        }
-      }
-    })
-  )
-}
-</script>
-
-<template>
-  <div class="algolia-search-box" id="docsearch" />
-</template>
-
-<style>
-.algolia-search-box {
-  padding-top: 1px;
-}
-
-@media (min-width: 720px) {
-  .algolia-search-box {
-    padding-left: 8px;
-  }
-}
-
-@media (min-width: 751px) {
-  .algolia-search-box {
-    min-width: 176.3px; /* avoid layout shift */
-  }
-
-  .algolia-search-box .DocSearch-Button-Placeholder {
-    padding-left: 8px;
-    font-size: 0.9rem;
-    font-weight: 500;
-  }
-}
-
-.DocSearch {
-  --docsearch-primary-color: var(--c-brand);
-  --docsearch-highlight-color: var(--docsearch-primary-color);
-  --docsearch-searchbox-shadow: inset 0 0 0 2px var(--docsearch-primary-color);
-  --docsearch-text-color: var(--c-text-light);
-  --docsearch-muted-color: var(--c-text-lighter);
-  --docsearch-searchbox-background: #f2f2f2;
-}
-</style>

package/dist/client/theme-default/components/BuySellAds.vue

@@ -1,152 +0,0 @@
-<script setup lang="ts">
-import { onMounted } from 'vue'
-
-// global _bsa
-const ID = 'bsa-cpc-script'
-
-declare global {
-  var _bsa: BSA | undefined
-
-  interface BSA {
-    init(
-      name: string,
-      code: string,
-      placement: string,
-      options: {
-        target: string
-        align: string
-        disable_css?: 'true' | 'false'
-      }
-    ): void
-  }
-}
-
-const { code, placement } = defineProps<{
-  code: string
-  placement: string
-}>()
-
-onMounted(() => {
-  if (!document.getElementById(ID)) {
-    const s = document.createElement('script')
-
-    s.id = ID
-    s.src = '//m.servedby-buysellads.com/monetization.js'
-
-    document.head.appendChild(s)
-
-    s.onload = () => {
-      load()
-    }
-  } else {
-    load()
-  }
-})
-
-function load() {
-  if (typeof _bsa !== 'undefined' && _bsa) {
-    const parent = document.querySelector('.bsa-cpc')!
-    // cleanup any existing ad to avoid them stacking
-    parent.innerHTML = ''
-
-    _bsa.init('default', code, `placement:${placement}`, {
-      target: '.bsa-cpc',
-      align: 'horizontal',
-      disable_css: 'true'
-    })
-  }
-}
-</script>
-
-<template>
-  <div class="buy-sell-ads">
-    <div class="bsa-cpc" />
-  </div>
-</template>
-
-<style scoped>
-.buy-sell-ads {
-  margin: 0 auto;
-  padding-top: 2rem;
-  font-size: 0.85rem;
-}
-
-.bsa-cpc {
-  border-radius: 6px;
-  background-color: var(--c-bg-accent);
-}
-
-.bsa-cpc ::v-deep(a._default_) {
-  display: flex;
-  flex-wrap: wrap;
-  align-items: flex-start;
-  margin-bottom: 20px;
-  padding: 12px;
-  text-decoration: none;
-  line-height: 1.4;
-  font-weight: 400;
-  color: var(--c-text-light);
-}
-
-@media (min-width: 512px) {
-  .bsa-cpc ::v-deep(a._default_) {
-    flex-wrap: nowrap;
-  }
-}
-
-.bsa-cpc ::v-deep(.default-ad) {
-  display: none;
-}
-
-.bsa-cpc ::v-deep(a._default_ .default-image) {
-  flex-shrink: 0;
-  margin-right: 12px;
-  width: 24px;
-}
-
-.bsa-cpc ::v-deep(a._default_ .default-image img) {
-  border-radius: 4px;
-  height: 24px;
-  vertical-align: middle;
-}
-
-.bsa-cpc ::v-deep(._default_::after) {
-  border: 1px solid #1c90f3;
-  border-radius: 4px;
-  margin-top: 8px;
-  margin-left: 36px;
-  padding: 0 8px;
-  line-height: 22px;
-  font-size: 0.85em;
-  font-weight: 500;
-  color: #1c90f3;
-  content: 'Sponsored';
-}
-
-@media (min-width: 512px) {
-  .bsa-cpc ::v-deep(._default_::after) {
-    margin-top: 0px;
-    margin-left: 12px;
-  }
-}
-
-.bsa-cpc ::v-deep(.default-text) {
-  flex-grow: 1;
-  align-self: center;
-  width: calc(100% - 36px);
-}
-
-@media (min-width: 512px) {
-  .bsa-cpc ::v-deep(.default-text) {
-    width: auto;
-  }
-}
-
-.bsa-cpc ::v-deep(.default-title) {
-  font-weight: 600;
-}
-
-.bsa-cpc ::v-deep(.default-description) {
-  padding-left: 8px;
-}
-</style>

package/dist/client/theme-default/components/CarbonAds.vue

@@ -1,99 +0,0 @@
-<script setup lang="ts">
-import { ref, onMounted } from 'vue'
-
-const { code, placement } = defineProps<{
-  code: string
-  placement: string
-}>()
-
-const el = ref()
-
-onMounted(() => {
-  const s = document.createElement('script')
-  s.id = '_carbonads_js'
-  s.src = `//cdn.carbonads.com/carbon.js?serve=${code}&placement=${placement}`
-  el.value.appendChild(s)
-})
-</script>
-
-<template>
-  <div class="carbon-ads" ref="el" />
-</template>
-
-<style scoped>
-.carbon-ads {
-  border-radius: 4px;
-  margin: 0 auto;
-  padding: 8px;
-  max-width: 280px;
-  font-size: 0.75rem;
-  background-color: var(--c-bg-accent);
-  min-height: 105.38px; /* avoid layout shift on mobile */
-}
-
-.carbon-ads::after {
-  clear: both;
-  display: block;
-  content: '';
-}
-
-@media (min-width: 420px) {
-  .carbon-ads {
-    z-index: 1;
-    float: right;
-    margin: -8px -8px 24px 24px;
-    width: 146px;
-    max-width: 100%;
-    min-height: 200px;
-  }
-}
-
-@media (min-width: 1400px) {
-  .carbon-ads {
-    right: 8px;
-    float: none;
-    margin: 0;
-  }
-}
-
-.carbon-ads :deep(.carbon-img) {
-  float: left;
-  margin-right: 0.75rem;
-  max-width: 110px;
-  border: 1px solid var(--c-divider);
-}
-
-@media (min-width: 420px) {
-  .carbon-ads :deep(.carbon-img) {
-    float: none;
-    display: block;
-    margin-right: 0;
-    max-width: 130px;
-  }
-}
-
-.carbon-ads :deep(.carbon-img img) {
-  display: block;
-  width: 100%;
-  height: auto;
-}
-
-@media (min-width: 420px) {
-  .carbon-ads :deep(.carbon-text) {
-    padding-top: 8px;
-  }
-}
-
-.carbon-ads :deep(.carbon-text) {
-  display: block;
-  font-weight: 400;
-  color: var(--c-text-light);
-}
-
-.carbon-ads :deep(.carbon-poweredby) {
-  display: block;
-  padding-top: 2px;
-  font-weight: 400;
-  color: var(--c-text-lighter);
-}
-</style>