vitepress 0.21.4 → 0.21.5

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.
@@ -148,7 +149,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>;
 
@@ -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/node/cli.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var serve = require('./serve-9731a371.js');
+var serve = require('./serve-322f3382.js');
 require('fs');
 require('path');
 require('url');

package/dist/node/index.d.ts

@@ -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
@@ -301,6 +302,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-322f3382.js');
 require('vite');
 require('readline');
 require('assert');

package/dist/node/{serve-9731a371.js → serve-322f3382.js}

@@ -13455,7 +13455,8 @@ async function resolveSiteData(root, userConfig, command = "serve", mode = "deve
     head: userConfig.head || [],
     themeConfig: userConfig.themeConfig || {},
     locales: userConfig.locales || {},
-    langs: createLangDictionary(userConfig)
+    langs: createLangDictionary(userConfig),
+    scrollOffset: userConfig.scrollOffset || 90
   };
 }
 
@@ -24508,7 +24509,7 @@ Renderer$1.prototype.renderToken = function renderToken(tokens, idx, options) {
 
 /**
  * Renderer.renderInline(tokens, options, env) -> String
- * - tokens (Array): list on block tokens to renter
+ * - tokens (Array): list on block tokens to render
  * - options (Object): params of parser instance
  * - env (Object): additional data from parsed input (references, for example)
  *
@@ -24535,7 +24536,7 @@ Renderer$1.prototype.renderInline = function (tokens, options, env) {
 
 /** internal
  * Renderer.renderInlineAsText(tokens, options, env) -> String
- * - tokens (Array): list on block tokens to renter
+ * - tokens (Array): list on block tokens to render
  * - options (Object): params of parser instance
  * - env (Object): additional data from parsed input (references, for example)
  *
@@ -24562,7 +24563,7 @@ Renderer$1.prototype.renderInlineAsText = function (tokens, options, env) {
 
 /**
  * Renderer.render(tokens, options, env) -> String
- * - tokens (Array): list on block tokens to renter
+ * - tokens (Array): list on block tokens to render
  * - options (Object): params of parser instance
  * - env (Object): additional data from parsed input (references, for example)
  *
@@ -26492,7 +26493,7 @@ var list$1 = function list(state, startLine, endLine, silent) {
     // This code can fail if plugins use blkIndent as well as lists,
     // but I hope the spec gets fixed long before that happens.
     //
-    if (state.tShift[startLine] >= state.blkIndent) {
+    if (state.sCount[startLine] >= state.blkIndent) {
       isTerminatingParagraph = true;
     }
   }
@@ -27644,7 +27645,7 @@ var isSpace$3 = utils$3.isSpace;
 
 
 var newline = function newline(state, silent) {
-  var pmax, max, pos = state.pos;
+  var pmax, max, ws, pos = state.pos;
 
   if (state.src.charCodeAt(pos) !== 0x0A/* \n */) { return false; }
 
@@ -27658,7 +27659,11 @@ var newline = function newline(state, silent) {
   if (!silent) {
     if (pmax >= 0 && state.pending.charCodeAt(pmax) === 0x20) {
       if (pmax >= 1 && state.pending.charCodeAt(pmax - 1) === 0x20) {
-        state.pending = state.pending.replace(/ +$/, '');
+        // Find whitespaces tail of pending chars.
+        ws = pmax - 1;
+        while (ws >= 1 && state.pending.charCodeAt(ws - 1) === 0x20) ws--;
+
+        state.pending = state.pending.slice(0, ws);
         state.push('hardbreak', 'br', 0);
       } else {
         state.pending = state.pending.slice(0, -1);
@@ -27819,7 +27824,6 @@ strikethrough.tokenize = function strikethrough(state, silent) {
     state.delimiters.push({
       marker: marker,
       length: 0,     // disable "rule of 3" length checks meant for emphasis
-      jump:   i / 2, // for `~~` 1 marker = 2 characters
       token:  state.tokens.length - 1,
       end:    -1,
       open:   scanned.can_open,
@@ -27944,15 +27948,6 @@ emphasis.tokenize = function emphasis(state, silent) {
       //
       length: scanned.length,
 
-      // An amount of characters before this one that's equivalent to
-      // current one. In plain English: if this delimiter does not open
-      // an emphasis, neither do previous `jump` characters.
-      //
-      // Used to skip sequences like "*****" in one step, for 1st asterisk
-      // value will be 0, for 2nd it's 1 and so on.
-      //
-      jump:   i,
-
       // A position of the token this delimiter corresponds to.
       //
       token:  state.tokens.length - 1,
@@ -28006,9 +28001,11 @@ function postProcess(state, delimiters) {
     //
     isStrong = i > 0 &&
                delimiters[i - 1].end === startDelim.end + 1 &&
+               // check that first two markers match and adjacent
+               delimiters[i - 1].marker === startDelim.marker &&
                delimiters[i - 1].token === startDelim.token - 1 &&
-               delimiters[startDelim.end + 1].token === endDelim.token + 1 &&
-               delimiters[i - 1].marker === startDelim.marker;
+               // check that last two markers are adjacent (we can safely assume they match)
+               delimiters[startDelim.end + 1].token === endDelim.token + 1;
 
     ch = String.fromCharCode(startDelim.marker);
 
@@ -28511,9 +28508,28 @@ function processDelimiters(state, delimiters) {
       openersBottom = {},
       max = delimiters.length;
 
+  if (!max) return;
+
+  // headerIdx is the first delimiter of the current (where closer is) delimiter run
+  var headerIdx = 0;
+  var lastTokenIdx = -2; // needs any value lower than -1
+  var jumps = [];
+
   for (closerIdx = 0; closerIdx < max; closerIdx++) {
     closer = delimiters[closerIdx];
 
+    jumps.push(0);
+
+    // markers belong to same delimiter run if:
+    //  - they have adjacent tokens
+    //  - AND markers are the same
+    //
+    if (delimiters[headerIdx].marker !== closer.marker || lastTokenIdx !== closer.token - 1) {
+      headerIdx = closerIdx;
+    }
+
+    lastTokenIdx = closer.token;
+
     // Length is only used for emphasis-specific "rule of 3",
     // if it's not defined (in strikethrough or 3rd party plugins),
     // we can default it to 0 to disable those checks.
@@ -28532,14 +28548,11 @@ function processDelimiters(state, delimiters) {
 
     minOpenerIdx = openersBottom[closer.marker][(closer.open ? 3 : 0) + (closer.length % 3)];
 
-    openerIdx = closerIdx - closer.jump - 1;
-
-    // avoid crash if `closer.jump` is pointing outside of the array, see #742
-    if (openerIdx < -1) openerIdx = -1;
+    openerIdx = headerIdx - jumps[headerIdx] - 1;
 
     newMinOpenerIdx = openerIdx;
 
-    for (; openerIdx > minOpenerIdx; openerIdx -= opener.jump + 1) {
+    for (; openerIdx > minOpenerIdx; openerIdx -= jumps[openerIdx] + 1) {
       opener = delimiters[openerIdx];
 
       if (opener.marker !== closer.marker) continue;
@@ -28569,15 +28582,19 @@ function processDelimiters(state, delimiters) {
           // sure algorithm has linear complexity (see *_*_*_*_*_... case).
           //
           lastJump = openerIdx > 0 && !delimiters[openerIdx - 1].open ?
-            delimiters[openerIdx - 1].jump + 1 :
+            jumps[openerIdx - 1] + 1 :
             0;
 
-          closer.jump  = closerIdx - openerIdx + lastJump;
+          jumps[closerIdx] = closerIdx - openerIdx + lastJump;
+          jumps[openerIdx] = lastJump;
+
           closer.open  = false;
           opener.end   = closerIdx;
-          opener.jump  = lastJump;
           opener.close = false;
           newMinOpenerIdx = -1;
+          // treat next token as start of run,
+          // it optimizes skips in **<...>**a**<...>** pathological case
+          lastTokenIdx = -2;
           break;
         }
       }
@@ -35151,7 +35168,7 @@ const headingPlugin = (md, include = ["h2", "h3"]) => {
   };
 };
 
-var e=!1,n={false:"push",true:"unshift",after:"push",before:"unshift"},t={isPermalinkSymbol:!0};function r(r,a,i,l){var o;if(!e){var c="Using deprecated markdown-it-anchor permalink option, see https://github.com/valeriangalliat/markdown-it-anchor#todo-anchor-or-file";"object"==typeof process&&process&&process.emitWarning?process.emitWarning(c):console.warn(c),e=!0;}var s=[Object.assign(new i.Token("link_open","a",1),{attrs:[].concat(a.permalinkClass?[["class",a.permalinkClass]]:[],[["href",a.permalinkHref(r,i)]],Object.entries(a.permalinkAttrs(r,i)))}),Object.assign(new i.Token("html_block","",0),{content:a.permalinkSymbol,meta:t}),new i.Token("link_close","a",-1)];a.permalinkSpace&&i.tokens[l+1].children[n[a.permalinkBefore]](Object.assign(new i.Token("text","",0),{content:" "})),(o=i.tokens[l+1].children)[n[a.permalinkBefore]].apply(o,s);}function a(e){return "#"+e}function i(e){return {}}var l={class:"header-anchor",symbol:"#",renderHref:a,renderAttrs:i};function o(e){function n(t){return t=Object.assign({},n.defaults,t),function(n,r,a,i){return e(n,t,r,a,i)}}return n.defaults=Object.assign({},l),n.renderPermalinkImpl=e,n}var c=o(function(e,r,a,i,l){var o,c=[Object.assign(new i.Token("link_open","a",1),{attrs:[].concat(r.class?[["class",r.class]]:[],[["href",r.renderHref(e,i)]],r.ariaHidden?[["aria-hidden","true"]]:[],Object.entries(r.renderAttrs(e,i)))}),Object.assign(new i.Token("html_inline","",0),{content:r.symbol,meta:t}),new i.Token("link_close","a",-1)];r.space&&i.tokens[l+1].children[n[r.placement]](Object.assign(new i.Token("text","",0),{content:" "})),(o=i.tokens[l+1].children)[n[r.placement]].apply(o,c);});Object.assign(c.defaults,{space:!0,placement:"after",ariaHidden:!1});var s$1=o(c.renderPermalinkImpl);s$1.defaults=Object.assign({},c.defaults,{ariaHidden:!0});var d$1=o(function(e,n,t,r,a){var i=[Object.assign(new r.Token("link_open","a",1),{attrs:[].concat(n.class?[["class",n.class]]:[],[["href",n.renderHref(e,r)]],Object.entries(n.renderAttrs(e,r)))})].concat(r.tokens[a+1].children,[new r.Token("link_close","a",-1)]);r.tokens[a+1]=Object.assign(new r.Token("inline","",0),{children:i});}),u=o(function(e,r,a,i,l){var o;if(!["visually-hidden","aria-label","aria-describedby","aria-labelledby"].includes(r.style))throw new Error("`permalink.linkAfterHeader` called with unknown style option `"+r.style+"`");if(!["aria-describedby","aria-labelledby"].includes(r.style)&&!r.assistiveText)throw new Error("`permalink.linkAfterHeader` called without the `assistiveText` option in `"+r.style+"` style");if("visually-hidden"===r.style&&!r.visuallyHiddenClass)throw new Error("`permalink.linkAfterHeader` called without the `visuallyHiddenClass` option in `visually-hidden` style");var c=i.tokens[l+1].children.filter(function(e){return "text"===e.type||"code_inline"===e.type}).reduce(function(e,n){return e+n.content},""),s=[],d=[];r.class&&d.push(["class",r.class]),d.push(["href",r.renderHref(e,i)]),d.push.apply(d,Object.entries(r.renderAttrs(e,i))),"visually-hidden"===r.style?(s.push(Object.assign(new i.Token("span_open","span",1),{attrs:[["class",r.visuallyHiddenClass]]}),Object.assign(new i.Token("text","",0),{content:r.assistiveText(c)}),new i.Token("span_close","span",-1)),r.space&&s[n[r.placement]](Object.assign(new i.Token("text","",0),{content:" "})),s[n[r.placement]](Object.assign(new i.Token("span_open","span",1),{attrs:[["aria-hidden","true"]]}),Object.assign(new i.Token("html_inline","",0),{content:r.symbol,meta:t}),new i.Token("span_close","span",-1))):s.push(Object.assign(new i.Token("html_inline","",0),{content:r.symbol,meta:t})),"aria-label"===r.style?d.push(["aria-label",r.assistiveText(c)]):["aria-describedby","aria-labelledby"].includes(r.style)&&d.push([r.style,e]);var u=[Object.assign(new i.Token("link_open","a",1),{attrs:d})].concat(s,[new i.Token("link_close","a",-1)]);(o=i.tokens).splice.apply(o,[l+3,0].concat(u));});function f(e,n,t,r){var a=e,i=r;if(t&&Object.prototype.hasOwnProperty.call(n,a))throw new Error("User defined `id` attribute `"+e+"` is not unique. Please fix it in your Markdown to continue.");for(;Object.prototype.hasOwnProperty.call(n,a);)a=e+"-"+i,i+=1;return n[a]=!0,a}function b(e,n){n=Object.assign({},b.defaults,n),e.core.ruler.push("anchor",function(e){for(var t,a={},i=e.tokens,l=Array.isArray(n.level)?(t=n.level,function(e){return t.includes(e)}):function(e){return function(n){return n>=e}}(n.level),o=0;o<i.length;o++){var c=i[o];if("heading_open"===c.type&&l(Number(c.tag.substr(1)))){var s=i[o+1].children.filter(function(e){return "text"===e.type||"code_inline"===e.type}).reduce(function(e,n){return e+n.content},""),d=c.attrGet("id");d=null==d?f(n.slugify(s),a,!1,n.uniqueSlugStartIndex):f(d,a,!0,n.uniqueSlugStartIndex),c.attrSet("id",d),!1!==n.tabIndex&&c.attrSet("tabindex",""+n.tabIndex),"function"==typeof n.permalink?n.permalink(d,n,e,o):(n.permalink||n.renderPermalink&&n.renderPermalink!==r)&&n.renderPermalink(d,n,e,o),o=i.indexOf(c),n.callback&&n.callback(c,{slug:d,title:s});}}});}Object.assign(u.defaults,{style:"visually-hidden",space:!0,placement:"after"}),b.permalink={__proto__:null,legacy:r,renderHref:a,renderAttrs:i,makePermalink:o,linkInsideHeader:c,ariaHidden:s$1,headerLink:d$1,linkAfterHeader:u},b.defaults={level:1,slugify:function(e){return encodeURIComponent(String(e).trim().toLowerCase().replace(/\s+/g,"-"))},uniqueSlugStartIndex:1,tabIndex:"-1",permalink:!1,renderPermalink:r,permalinkClass:s$1.defaults.class,permalinkSpace:s$1.defaults.space,permalinkSymbol:"¶",permalinkBefore:"before"===s$1.defaults.placement,permalinkHref:s$1.defaults.renderHref,permalinkAttrs:s$1.defaults.renderAttrs},b.default=b;
+var e=!1,n={false:"push",true:"unshift",after:"push",before:"unshift"},t={isPermalinkSymbol:!0};function r(r,a,i,l){var o;if(!e){var c="Using deprecated markdown-it-anchor permalink option, see https://github.com/valeriangalliat/markdown-it-anchor#todo-anchor-or-file";"object"==typeof process&&process&&process.emitWarning?process.emitWarning(c):console.warn(c),e=!0;}var s=[Object.assign(new i.Token("link_open","a",1),{attrs:[].concat(a.permalinkClass?[["class",a.permalinkClass]]:[],[["href",a.permalinkHref(r,i)]],Object.entries(a.permalinkAttrs(r,i)))}),Object.assign(new i.Token("html_block","",0),{content:a.permalinkSymbol,meta:t}),new i.Token("link_close","a",-1)];a.permalinkSpace&&i.tokens[l+1].children[n[a.permalinkBefore]](Object.assign(new i.Token("text","",0),{content:" "})),(o=i.tokens[l+1].children)[n[a.permalinkBefore]].apply(o,s);}function a(e){return "#"+e}function i(e){return {}}var l={class:"header-anchor",symbol:"#",renderHref:a,renderAttrs:i};function o(e){function n(t){return t=Object.assign({},n.defaults,t),function(n,r,a,i){return e(n,t,r,a,i)}}return n.defaults=Object.assign({},l),n.renderPermalinkImpl=e,n}var c=o(function(e,r,a,i,l){var o,c=[Object.assign(new i.Token("link_open","a",1),{attrs:[].concat(r.class?[["class",r.class]]:[],[["href",r.renderHref(e,i)]],r.ariaHidden?[["aria-hidden","true"]]:[],Object.entries(r.renderAttrs(e,i)))}),Object.assign(new i.Token("html_inline","",0),{content:r.symbol,meta:t}),new i.Token("link_close","a",-1)];r.space&&i.tokens[l+1].children[n[r.placement]](Object.assign(new i.Token("text","",0),{content:" "})),(o=i.tokens[l+1].children)[n[r.placement]].apply(o,c);});Object.assign(c.defaults,{space:!0,placement:"after",ariaHidden:!1});var s$1=o(c.renderPermalinkImpl);s$1.defaults=Object.assign({},c.defaults,{ariaHidden:!0});var d$1=o(function(e,n,t,r,a){var i=[Object.assign(new r.Token("link_open","a",1),{attrs:[].concat(n.class?[["class",n.class]]:[],[["href",n.renderHref(e,r)]],Object.entries(n.renderAttrs(e,r)))})].concat(n.safariReaderFix?[new r.Token("span_open","span",1)]:[],r.tokens[a+1].children,n.safariReaderFix?[new r.Token("span_close","span",-1)]:[],[new r.Token("link_close","a",-1)]);r.tokens[a+1]=Object.assign(new r.Token("inline","",0),{children:i});});Object.assign(d$1.defaults,{safariReaderFix:!1});var u=o(function(e,r,a,i,l){var o;if(!["visually-hidden","aria-label","aria-describedby","aria-labelledby"].includes(r.style))throw new Error("`permalink.linkAfterHeader` called with unknown style option `"+r.style+"`");if(!["aria-describedby","aria-labelledby"].includes(r.style)&&!r.assistiveText)throw new Error("`permalink.linkAfterHeader` called without the `assistiveText` option in `"+r.style+"` style");if("visually-hidden"===r.style&&!r.visuallyHiddenClass)throw new Error("`permalink.linkAfterHeader` called without the `visuallyHiddenClass` option in `visually-hidden` style");var c=i.tokens[l+1].children.filter(function(e){return "text"===e.type||"code_inline"===e.type}).reduce(function(e,n){return e+n.content},""),s=[],d=[];r.class&&d.push(["class",r.class]),d.push(["href",r.renderHref(e,i)]),d.push.apply(d,Object.entries(r.renderAttrs(e,i))),"visually-hidden"===r.style?(s.push(Object.assign(new i.Token("span_open","span",1),{attrs:[["class",r.visuallyHiddenClass]]}),Object.assign(new i.Token("text","",0),{content:r.assistiveText(c)}),new i.Token("span_close","span",-1)),r.space&&s[n[r.placement]](Object.assign(new i.Token("text","",0),{content:" "})),s[n[r.placement]](Object.assign(new i.Token("span_open","span",1),{attrs:[["aria-hidden","true"]]}),Object.assign(new i.Token("html_inline","",0),{content:r.symbol,meta:t}),new i.Token("span_close","span",-1))):s.push(Object.assign(new i.Token("html_inline","",0),{content:r.symbol,meta:t})),"aria-label"===r.style?d.push(["aria-label",r.assistiveText(c)]):["aria-describedby","aria-labelledby"].includes(r.style)&&d.push([r.style,e]);var u=[Object.assign(new i.Token("link_open","a",1),{attrs:d})].concat(s,[new i.Token("link_close","a",-1)]);(o=i.tokens).splice.apply(o,[l+3,0].concat(u));});function f(e,n,t,r){var a=e,i=r;if(t&&Object.prototype.hasOwnProperty.call(n,a))throw new Error("User defined `id` attribute `"+e+"` is not unique. Please fix it in your Markdown to continue.");for(;Object.prototype.hasOwnProperty.call(n,a);)a=e+"-"+i,i+=1;return n[a]=!0,a}function b(e,n){n=Object.assign({},b.defaults,n),e.core.ruler.push("anchor",function(e){for(var t,a={},i=e.tokens,l=Array.isArray(n.level)?(t=n.level,function(e){return t.includes(e)}):function(e){return function(n){return n>=e}}(n.level),o=0;o<i.length;o++){var c=i[o];if("heading_open"===c.type&&l(Number(c.tag.substr(1)))){var s=i[o+1].children.filter(function(e){return "text"===e.type||"code_inline"===e.type}).reduce(function(e,n){return e+n.content},""),d=c.attrGet("id");d=null==d?f(n.slugify(s),a,!1,n.uniqueSlugStartIndex):f(d,a,!0,n.uniqueSlugStartIndex),c.attrSet("id",d),!1!==n.tabIndex&&c.attrSet("tabindex",""+n.tabIndex),"function"==typeof n.permalink?n.permalink(d,n,e,o):(n.permalink||n.renderPermalink&&n.renderPermalink!==r)&&n.renderPermalink(d,n,e,o),o=i.indexOf(c),n.callback&&n.callback(c,{slug:d,title:s});}}});}Object.assign(u.defaults,{style:"visually-hidden",space:!0,placement:"after"}),b.permalink={__proto__:null,legacy:r,renderHref:a,renderAttrs:i,makePermalink:o,linkInsideHeader:c,ariaHidden:s$1,headerLink:d$1,linkAfterHeader:u},b.defaults={level:1,slugify:function(e){return encodeURIComponent(String(e).trim().toLowerCase().replace(/\s+/g,"-"))},uniqueSlugStartIndex:1,tabIndex:"-1",permalink:!1,renderPermalink:r,permalinkClass:s$1.defaults.class,permalinkSpace:s$1.defaults.space,permalinkSymbol:"¶",permalinkBefore:"before"===s$1.defaults.placement,permalinkHref:s$1.defaults.renderHref,permalinkAttrs:s$1.defaults.renderAttrs},b.default=b;
 
 var utils$1 = {};
 
@@ -35727,7 +35744,8 @@ var patterns = options => {
         token.nesting = 0;
         let content = tokens[i + 1].content;
         let start = content.lastIndexOf(options.leftDelimiter);
-        token.attrs = utils.getAttrs(content, start, options);
+        let attrs = utils.getAttrs(content, start, options);
+        utils.addAttrs(attrs, token);
         token.markup = content;
         tokens.splice(i + 1, 2);
       }
@@ -35744,7 +35762,7 @@ var patterns = options => {
             {
               position: -1,
               content: utils.hasDelimiters('end', options),
-              type: (t) => t !== 'code_inline'
+              type: (t) => t !== 'code_inline' && t !== 'math_inline'
             }
           ]
         }
@@ -35827,6 +35845,12 @@ function test(tokens, i, t) {
   let ii = t.shift !== undefined
     ? i + t.shift
     : t.position;
+
+  if (t.shift !== undefined && ii < 0) {
+    // we should never shift to negative indexes (rolling around to back of array)
+    return res;
+  }
+
   let token = get(tokens, ii);  // supports negative ii
 
 
@@ -36129,16 +36153,25 @@ var markdownItEmoji = function emoji_plugin(md, options) {
   bare_emoji_plugin(md, opts);
 };
 
-var slugify = function(s){
-  return encodeURIComponent(String(s).trim().toLowerCase().replace(/\s+/g, '-'))
+/*
+* markdown-it-table-of-contents
+*
+* The algorithm works as follows:
+* Step 1: Gather all headline tokens from a Markdown document and put them in an array.
+* Step 2: Turn the flat array into a nested tree, respecting the correct headline level.
+* Step 3: Turn the nested tree into HTML code.
+*/
+
+const slugify = function (s) {
+  return encodeURIComponent(String(s).trim().toLowerCase().replace(/\s+/g, '-'));
 };
-var defaults$2 = {
-  includeLevel: [ 1, 2 ],
+const defaults$2 = {
+  includeLevel: [1, 2],
   containerClass: 'table-of-contents',
   slugify: slugify,
   markerPattern: /^\[\[toc\]\]/im,
   listType: 'ul',
-  format: function(content, md) {
+  format: function (content, md) {
     return md.renderInline(content);
   },
   forceFullToc: false,
@@ -36147,17 +36180,182 @@ var defaults$2 = {
   transformLink: undefined,
 };
 
-var markdownItTableOfContents = function(md, o) {
-  var options = Object.assign({}, defaults$2, o);
-  var tocRegexp = options.markerPattern;
-  var gstate;
+/**
+* @typedef {Object} HeadlineItem
+* @property {number} level Headline level
+* @property {string} anchor Anchor target
+* @property {string} text Text of headline
+*/
+
+/**
+* @typedef {Object} TocItem
+* @property {number} level Item level
+* @property {string} text Text of link
+* @property {string} anchor Target of link
+* @property {Array<TocItem>} children Sub-items for this list item
+* @property {TocItem} parent Parent this item belongs to
+*/
+
+/**
+* Finds all headline items for the defined levels in a Markdown document.
+* @param {Array<number>} levels includeLevels like `[1, 2, 3]`
+* @param {*} tokens Tokens gathered by the plugin
+* @param {*} options Plugin options
+* @returns {Array<HeadlineItem>}
+*/
+function findHeadlineElements(levels, tokens, options) {
+  const headings = [];
+  let currentHeading = null;
+
+  tokens.forEach(token => {
+    if (token.type === 'heading_open') {
+      const id = findExistingIdAttr(token);
+      const level = parseInt(token.tag.toLowerCase().replace('h', ''), 10);
+      if (levels.indexOf(level) >= 0) {
+        currentHeading = {
+          level: level,
+          text: null,
+          anchor: id || null
+        };
+      }
+    }
+    else if (currentHeading && token.type === 'inline') {
+      const textContent = token.children
+        .filter((childToken) => childToken.type === 'text' || childToken.type === 'code_inline')
+        .reduce((acc, t) => acc + t.content, '');
+      currentHeading.text = textContent;
+      if (! currentHeading.anchor) {
+        currentHeading.anchor = options.slugify(textContent, token.content);
+      }
+    }
+    else if (token.type === 'heading_close') {
+      if (currentHeading) {
+        headings.push(currentHeading);
+      }
+      currentHeading = null;
+    }
+  });
+
+  return headings;
+}
+
+/**
+* Helper to find an existing id attr on a token. Should be a heading_open token, but could be anything really
+* Provided by markdown-it-anchor or markdown-it-attrs
+* @param {any} token Token
+* @returns {string} Id attribute to use as anchor
+*/
+function findExistingIdAttr(token) {
+  if (token && token.attrs && token.attrs.length > 0) {
+    const idAttr = token.attrs.find( (attr) => {
+      if (Array.isArray(attr) && attr.length >= 2) {
+        return attr[0] === 'id';
+      }
+      return false;
+    });
+    if (idAttr && Array.isArray(idAttr) && idAttr.length >= 2) {
+      const [key, val] = idAttr;
+      return val;
+    }
+  }
+  return null;
+}
+
+/**
+* Helper to get minimum headline level so that the TOC is nested correctly
+* @param {Array<HeadlineItem>} headlineItems Search these
+* @returns {number} Minimum level
+*/
+function getMinLevel(headlineItems) {
+  return Math.min(...headlineItems.map(item => item.level));
+}
+
+/**
+* Helper that creates a TOCItem
+* @param {number} level
+* @param {string} text
+* @param {string} anchor
+* @param {TocItem} rootNode
+* @returns {TocItem}
+*/
+function addListItem(level, text, anchor, rootNode) {
+  const listItem = { level, text, anchor, children: [], parent: rootNode };
+  rootNode.children.push(listItem);
+  return listItem;
+}
+
+/**
+* Turns a list of flat headline items into a nested tree object representing the TOC
+* @param {Array<HeadlineItem>} headlineItems
+* @returns {TocItem} Tree of TOC items
+*/
+function flatHeadlineItemsToNestedTree(headlineItems) {
+  // create a root node with no text that holds the entire TOC. this won't be rendered, but only its children
+  const toc = { level: getMinLevel(headlineItems) - 1, anchor: null, text: null, children: [], parent: null };
+  // pointer that tracks the last root item of the current list
+  let currentRootNode = toc;
+  // pointer that tracks the last item (to turn it into a new root node if necessary)
+  let prevListItem = currentRootNode;
+
+  headlineItems.forEach(headlineItem => {
+    // if level is bigger, take the previous node, add a child list, set current list to this new child list
+    if (headlineItem.level > prevListItem.level) {
+      // eslint-disable-next-line no-unused-vars
+      Array.from({ length: headlineItem.level - prevListItem.level }).forEach(_ => {
+        currentRootNode = prevListItem;
+        prevListItem = addListItem(headlineItem.level, null, null, currentRootNode);
+      });
+      prevListItem.text = headlineItem.text;
+      prevListItem.anchor = headlineItem.anchor;
+    }
+    // if level is same, add to the current list
+    else if (headlineItem.level === prevListItem.level) {
+      prevListItem = addListItem(headlineItem.level, headlineItem.text, headlineItem.anchor, currentRootNode);
+    }
+    // if level is smaller, set current list to currentlist.parent
+    else if (headlineItem.level < prevListItem.level) {
+      for (let i = 0; i < prevListItem.level - headlineItem.level; i++) {
+        currentRootNode = currentRootNode.parent;
+      }
+      prevListItem = addListItem(headlineItem.level, headlineItem.text, headlineItem.anchor, currentRootNode);
+    }
+  });
+
+  return toc;
+}
+
+/**
+* Recursively turns a nested tree of tocItems to HTML.
+* @param {TocItem} tocItem
+* @returns {string}
+*/
+function tocItemToHtml(tocItem, options, md) {
+  return '<' + options.listType + '>' + tocItem.children.map(childItem => {
+    let li = '<li>';
+    let anchor = childItem.anchor;
+    if (options && options.transformLink) {
+      anchor = options.transformLink(anchor);
+    }
+
+    let text = childItem.text ? options.format(childItem.text, md, anchor) : null;
+
+    li += anchor ? `<a href="#${anchor}">${text}</a>` : (text || '');
+
+    return li + (childItem.children.length > 0 ? tocItemToHtml(childItem, options, md) : '') + '</li>';
+  }).join('') + '</' + options.listType + '>';
+}
+
+var markdownItTableOfContents = function (md, o) {
+  const options = Object.assign({}, defaults$2, o);
+  const tocRegexp = options.markerPattern;
+  let gstate;
 
   function toc(state, silent) {
-    var token;
-    var match;
+    let token;
+    let match;
 
     // Reject if the token does not start with [
-    if (state.src.charCodeAt(state.pos) !== 0x5B /* [ */ ) {
+    if (state.src.charCodeAt(state.pos) !== 0x5B /* [ */) {
       return false;
     }
     // Don't run any pairs in validation mode
@@ -36167,7 +36365,7 @@ var markdownItTableOfContents = function(md, o) {
 
     // Detect TOC markdown
     match = tocRegexp.exec(state.src.substr(state.pos));
-    match = !match ? [] : match.filter(function(m) { return m; });
+    match = !match ? [] : match.filter(function (m) { return m; });
     if (match.length < 1) {
       return false;
     }
@@ -36189,8 +36387,8 @@ var markdownItTableOfContents = function(md, o) {
     return true;
   }
 
-  md.renderer.rules.toc_open = function(tokens, index) {
-    var tocOpenHtml = '<div class="'+ options.containerClass +'">';
+  md.renderer.rules.toc_open = function (tokens, index) {
+    var tocOpenHtml = '<div class="' + options.containerClass + '">';
 
     if (options.containerHeaderHtml) {
       tocOpenHtml += options.containerHeaderHtml;
@@ -36199,7 +36397,7 @@ var markdownItTableOfContents = function(md, o) {
     return tocOpenHtml;
   };
 
-  md.renderer.rules.toc_close = function(tokens, index) {
+  md.renderer.rules.toc_close = function (tokens, index) {
     var tocFooterHtml = '';
 
     if (options.containerFooterHtml) {
@@ -36209,69 +36407,19 @@ var markdownItTableOfContents = function(md, o) {
     return tocFooterHtml + '</div>';
   };
 
-  md.renderer.rules.toc_body = function(tokens, index) {
+  md.renderer.rules.toc_body = function (tokens, index) {
     if (options.forceFullToc) {
-      throw("forceFullToc was removed in version 0.5.0. For more information, see https://github.com/Oktavilla/markdown-it-table-of-contents/pull/41")
+      throw ("forceFullToc was removed in version 0.5.0. For more information, see https://github.com/Oktavilla/markdown-it-table-of-contents/pull/41");
     } else {
-      return renderChildsTokens(0, gstate.tokens)[1];
+      const headlineItems = findHeadlineElements(options.includeLevel, gstate.tokens, options);
+      const toc = flatHeadlineItemsToNestedTree(headlineItems);
+      const html = tocItemToHtml(toc, options, md);
+      return html;
     }
   };
 
-  function renderChildsTokens(pos, tokens) {
-    var headings = [],
-        buffer = '',
-        currentLevel,
-        subHeadings,
-        size = tokens.length,
-        i = pos;
-    while(i < size) {
-      var token = tokens[i];
-      var heading = tokens[i - 1];
-      var level = token.tag && parseInt(token.tag.substr(1, 1));
-      if (token.type !== 'heading_close' || options.includeLevel.indexOf(level) == -1 || heading.type !== 'inline') {
-        i++; continue; // Skip if not matching criteria
-      }
-      if (!currentLevel) {
-        currentLevel = level;// We init with the first found level
-      } else {
-        if (level > currentLevel) {
-          subHeadings = renderChildsTokens(i, tokens);
-          buffer += subHeadings[1];
-          i = subHeadings[0];
-          continue;
-        }
-        if (level < currentLevel) {
-          // Finishing the sub headings
-          buffer += "</li>";
-          headings.push(buffer);
-          return [i, "<"+ options.listType +">"+ headings.join('') +"</"+ options.listType +">"];
-        }
-        if (level == currentLevel) {
-          // Finishing the sub headings
-          buffer += "</li>";
-          headings.push(buffer);
-        }
-      }
-      var content = heading.children
-        .filter((token) => token.type === 'text' || token.type === 'code_inline')
-        .reduce((acc, t) => acc + t.content, '');
-      var slugifiedContent = options.slugify(content);
-      var link = "#"+slugifiedContent;
-      if (options.transformLink) {
-          link = options.transformLink(link);
-      }
-      buffer = `<li><a href="${link}">`;
-      buffer += options.format(content, md, link);
-      buffer += `</a>`;
-      i++;
-    }
-    buffer += buffer === '' ? '' : '</li>';
-    headings.push(buffer);
-    return [i, "<"+ options.listType +">"+ headings.join('') +"</"+ options.listType +">"];
-  }
-
   // Catch all the tokens for iteration later
-  md.core.ruler.push('grab_state', function(state) {
+  md.core.ruler.push('grab_state', function (state) {
     gstate = state;
   });
 
@@ -36431,12 +36579,12 @@ export default {}<\/script>`);
   return tags;
 }
 const inferTitle = (frontmatter, content) => {
-  if (frontmatter.home) {
-    return "Home";
-  }
   if (frontmatter.title) {
     return deeplyParseHeader(frontmatter.title);
   }
+  if (frontmatter.home) {
+    return "Home";
+  }
   const match = content.match(/^\s*#+\s+(.*)/m);
   if (match) {
     return deeplyParseHeader(match[1].trim());
@@ -40083,7 +40231,7 @@ async function renderPage(config, page, result, appChunk, cssChunk, pageToHashMa
   const { __pageData } = require(path__default["default"].join(config.tempDir, pageServerJsFileName));
   const pageData = JSON.parse(__pageData);
   let preloadLinks = config.mpa ? appChunk ? [appChunk.fileName] : [] : result && appChunk ? [
-    ...new Set([
+    .../* @__PURE__ */ new Set([
       ...resolvePageImports(config, page, result, appChunk),
       pageClientJsFileName,
       appChunk.fileName

package/dist/vitepress.d.ts

@@ -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
@@ -301,6 +302,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vitepress",
-  "version": "0.21.4",
+  "version": "0.21.5",
   "description": "Vite & Vue powered static site generator",
   "main": "dist/node/index.js",
   "typings": "types/index.d.ts",
@@ -11,7 +11,8 @@
     "bin",
     "dist",
     "types",
-    "client.d.ts"
+    "client.d.ts",
+    "theme.d.ts"
   ],
   "engines": {
     "node": ">=12.0.0"
@@ -47,8 +48,8 @@
     "@docsearch/js": "^3.0.0-alpha.41",
     "@vitejs/plugin-vue": "^2.0.0",
     "prismjs": "^1.25.0",
-    "vite": "^2.7.0",
-    "vue": "^3.2.26"
+    "vite": "^2.7.12",
+    "vue": "^3.2.27"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.18.9",
@@ -59,7 +60,7 @@
     "@types/compression": "^1.7.0",
     "@types/debug": "^4.1.7",
     "@types/fs-extra": "^9.0.11",
-    "@types/jest": "^26.0.23",
+    "@types/jest": "^27.0.0",
     "@types/koa": "^2.13.1",
     "@types/koa-static": "^4.0.1",
     "@types/lru-cache": "^5.1.0",
@@ -74,7 +75,7 @@
     "debug": "^4.3.2",
     "diacritics": "^1.3.0",
     "enquirer": "^2.3.6",
-    "esbuild": "^0.13.4",
+    "esbuild": "^0.14.0",
     "escape-html": "^1.0.3",
     "execa": "^5.0.0",
     "fast-glob": "^3.2.7",
@@ -84,12 +85,12 @@
     "jest": "^27.0.1",
     "lint-staged": "^11.0.0",
     "lru-cache": "^6.0.0",
-    "markdown-it": "^12.0.6",
-    "markdown-it-anchor": "^8.1.2",
-    "markdown-it-attrs": "^4.0.0",
+    "markdown-it": "^12.3.2",
+    "markdown-it-anchor": "^8.4.1",
+    "markdown-it-attrs": "^4.1.3",
     "markdown-it-container": "^3.0.0",
     "markdown-it-emoji": "^2.0.0",
-    "markdown-it-table-of-contents": "^0.5.2",
+    "markdown-it-table-of-contents": "^0.6.0",
     "micromatch": "^4.0.4",
     "minimist": "^1.2.5",
     "npm-run-all": "^4.1.5",
@@ -98,7 +99,7 @@
     "prettier": "^2.3.0",
     "rimraf": "^3.0.2",
     "rollup": "^2.56.3",
-    "rollup-plugin-esbuild": "^4.5.0",
+    "rollup-plugin-esbuild": "^4.8.2",
     "semver": "^7.3.5",
     "sirv": "^1.0.12",
     "ts-jest": "^27.0.1",

package/theme.d.ts

@@ -0,0 +1,9 @@
+// so that users can do `import DefaultTheme from 'vitepress/theme'`
+import { ComponentOptions } from 'vue'
+
+declare const defaultTheme: {
+  Layout: ComponentOptions
+  NotFound: ComponentOptions
+}
+
+export default defaultTheme

package/types/shared.d.ts

@@ -22,6 +22,7 @@ export 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