vitepress 0.21.4 → 0.22.1

package/dist/client/app/data.js

@@ -5,7 +5,8 @@ import { withBase } from './utils';
 export const dataSymbol = Symbol();
 export const siteDataRef = shallowRef(parse(serializedSiteData));
 function parse(data) {
-    return readonly(JSON.parse(data));
+    const parsed = JSON.parse(data);
+    return (import.meta.env.DEV ? readonly(parsed) : parsed);
 }
 // hmr
 if (import.meta.hot) {

package/dist/client/app/router.js

@@ -1,5 +1,6 @@
 import { reactive, inject, markRaw, nextTick, readonly } from 'vue';
 import { inBrowser } from './utils';
+import { siteDataRef } from './data';
 export const RouterSymbol = Symbol();
 // we are just using URL to parse the pathname and hash - the base doesn't
 // matter and is only passed to support same-host hrefs.
@@ -29,7 +30,7 @@ export function createRouter(loadPageModule, fallbackComponent) {
         return loadPage(href);
     }
     let latestPendingPath = null;
-    async function loadPage(href, scrollPosition = 0) {
+    async function loadPage(href, scrollPosition = 0, isRetry = false) {
         const targetLoc = new URL(href, fakeHost);
         const pendingPath = (latestPendingPath = targetLoc.pathname);
         try {
@@ -74,6 +75,18 @@ export function createRouter(loadPageModule, fallbackComponent) {
             if (!err.message.match(/fetch/)) {
                 console.error(err);
             }
+            // retry on fetch fail: the page to hash map may have been invalidated
+            // because a new deploy happened while the page is open. Try to fetch
+            // the updated pageToHash map and fetch again.
+            if (!isRetry) {
+                try {
+                    const res = await fetch(siteDataRef.value.base + 'hashmap.json');
+                    window.__VP_HASH_MAP__ = await res.json();
+                    await loadPage(href, scrollPosition, true);
+                    return;
+                }
+                catch (e) { }
+            }
             if (latestPendingPath === pendingPath) {
                 latestPendingPath = null;
                 route.path = pendingPath;
@@ -148,7 +161,16 @@ function scrollTo(el, hash, smooth = false) {
         console.warn(e);
     }
     if (target) {
-        const targetTop = target.offsetTop;
+        let offset = siteDataRef.value.scrollOffset;
+        if (typeof offset === 'string') {
+            offset =
+                document.querySelector(offset).getBoundingClientRect().bottom + 24;
+        }
+        const targetPadding = parseInt(window.getComputedStyle(target).paddingTop, 10);
+        const targetTop = window.scrollY +
+            target.getBoundingClientRect().top -
+            offset +
+            targetPadding;
         // only smooth scroll if distance is smaller than screen height.
         if (!smooth || Math.abs(targetTop - window.scrollY) > window.innerHeight) {
             window.scrollTo(0, targetTop);

package/dist/client/index.d.ts

@@ -6,6 +6,7 @@ import { ComponentOptions } from 'vue';
 import { ComponentOptionsMixin } from 'vue';
 import { DefineComponent } from 'vue';
 import { EmitsOptions } from 'vue';
+import { ExtractPropTypes } from 'vue';
 import { Ref } from 'vue';
 import { RendererElement } from 'vue';
 import { RendererNode } from 'vue';
@@ -14,7 +15,7 @@ import { VNodeProps } from 'vue';
 
 export declare const Content: DefineComponent<    {}, () => VNode<RendererNode, RendererElement, {
 [key: string]: any;
-}>, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, EmitsOptions, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<{} & {} & {}>, {}>;
+}>, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, EmitsOptions, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<    {}>>, {}>;
 
 export declare const Debug: ComponentOptions<{}, any, any, any, any, any, any, any>;
 
@@ -51,7 +52,7 @@ export declare interface PageData {
     description: string
     headers: Header[]
     frontmatter: Record<string, any>
-    lastUpdated: number
+    lastUpdated?: number
 }
 
 export declare interface Route {
@@ -76,6 +77,7 @@ export declare interface SiteData<ThemeConfig = any> {
     description: string
     head: HeadConfig[]
     themeConfig: ThemeConfig
+    scrollOffset: number | string
     locales: Record<string, LocaleConfig>
     /**
      * Available locales for the site when it has defined `locales` in its

package/dist/client/shared.js

@@ -1,4 +1,5 @@
 export const EXTERNAL_URL_RE = /^https?:/i;
+// @ts-ignore
 export const inBrowser = typeof window !== 'undefined';
 function findMatchRoot(route, roots) {
     // first match to the routes with the most deep level.

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

@@ -1,5 +1,5 @@
 <script setup lang="ts">
-import { ref, computed, onMounted } from 'vue'
+import { ref, computed, onMounted, watchEffect } from 'vue'
 import { useData } from 'vitepress'
 
 const { theme, page } = useData()
@@ -17,9 +17,11 @@ const prefix = computed(() => {
 
 const datetime = ref('')
 onMounted(() => {
-  // locale string might be different based on end user
-  // and will lead to potential hydration mismatch if calculated at build time
-  datetime.value = new Date(page.value.lastUpdated).toLocaleString('en-US')
+  watchEffect(() => {
+    // locale string might be different based on end user
+    // and will lead to potential hydration mismatch if calculated at build time
+    datetime.value = new Date(page.value.lastUpdated!).toLocaleString('en-US')
+  })
 })
 </script>
 

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

@@ -1,6 +1,9 @@
 <script setup lang="ts">
 import EditLink from './EditLink.vue'
 import LastUpdated from './LastUpdated.vue'
+import { useData } from 'vitepress'
+
+const { page } = useData()
 </script>
 
 <template>
@@ -9,7 +12,7 @@ import LastUpdated from './LastUpdated.vue'
       <EditLink />
     </div>
     <div class="updated">
-      <LastUpdated />
+      <LastUpdated v-if="page.lastUpdated" />
     </div>
   </footer>
 </template>

package/dist/node/cli.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var serve = require('./serve-9731a371.js');
+var serve = require('./serve-c594fc71.js');
 require('fs');
 require('path');
 require('url');
@@ -13,6 +13,7 @@ require('util');
 require('buffer');
 require('punycode');
 require('prismjs');
+require('child_process');
 require('querystring');
 require('tty');
 require('net');

package/dist/node/index.d.ts

@@ -233,7 +233,7 @@ export declare interface ServeOptions {
     port?: number;
 }
 
-export declare interface SiteConfig<ThemeConfig = any> extends Pick<UserConfig, 'markdown' | 'vue' | 'vite' | 'shouldPreload' | 'mpa'> {
+export declare interface SiteConfig<ThemeConfig = any> extends Pick<UserConfig, 'markdown' | 'vue' | 'vite' | 'shouldPreload' | 'mpa' | 'lastUpdated'> {
     root: string;
     srcDir: string;
     site: SiteData<ThemeConfig>;
@@ -256,6 +256,7 @@ export declare interface SiteData<ThemeConfig = any> {
     description: string
     head: HeadConfig[]
     themeConfig: ThemeConfig
+    scrollOffset: number | string
     locales: Record<string, LocaleConfig>
     /**
      * Available locales for the site when it has defined `locales` in its
@@ -289,6 +290,7 @@ export declare interface UserConfig<ThemeConfig = any> {
     themeConfig?: ThemeConfig;
     locales?: Record<string, LocaleConfig>;
     markdown?: MarkdownOptions;
+    lastUpdated?: boolean;
     /**
      * Options to pass on to `@vitejs/plugin-vue`
      */
@@ -301,6 +303,11 @@ export declare interface UserConfig<ThemeConfig = any> {
     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.
+     */
+    scrollOffset?: number | string;
     /**
      * Enable MPA / zero-JS mode
      * @experimental

package/dist/node/index.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var serve = require('./serve-9731a371.js');
+var serve = require('./serve-c594fc71.js');
 require('vite');
 require('readline');
 require('assert');
@@ -15,6 +15,7 @@ require('fs');
 require('punycode');
 require('prismjs');
 require('url');
+require('child_process');
 require('querystring');
 require('tty');
 require('net');