chore(deps): update dependency vitepress to v2.0.0-alpha.19 - #1574

v2.0.0-alpha.19

Compare Source

Bug Fixes

• build: apply rewrites when computing createContentLoader urls (9e2148d)
• build: clear markdown cache with rewritten path on include change (5eac447), closes #​5035
• build: compose markdown preConfig hook when extending configs (c39a85a), closes #​5205
• build: don't apply docsearch css transform to pages matching its filter (fa0e48c)
• build: don't rely on checkout directory name when externalizing types (e6ba9d8)
• build: report links to pre-rewrite paths of rewritten pages as dead (3cf3f37)
• build: resolve additional configs by source path (5e4a9e7)
• build: resolve rewrites against externally injected pages too (769c10e)
• build: respect cleanUrls in content loader render (027f046), closes #​4331 #​5299
• build: track include importers by module id (c961655)
• build: prevent duplicate IDs in MiniSearch (#​5303) (505278c)
• build: remove stackTraceLimit Infinity for DEBUG (#​5318) (865d04b)
• build: retry file reads when out of file descriptors (da71173)
• cli: avoid onAfterConfigResolve (3fbaf9c)
• client: make the route the single source of truth for the URL hash (dcb7a75)
• markdown: preserve user-defined attributes (3f4530b), closes #​5123
• markdown: remove extra whitespace from container markup (b6d9cb8)
• markdown: skip circular includes (3372516)
• markdown: remove deprecated cjkFriendly option (27762ea)
• markdown: rename image option lazyLoading to lazyLoad (078786a)
• search: index changed files with srcDir-relative paths in dev (6b64f35), closes #​3374
• search: only index pages on dev updates (559fb24)
• search: serve a fresh search index after dev updates (1534a67)
• search: skip pages that fail to render instead of crashing dev server (3ffefa2)
• theme: use ul and li for lists (#​5326) (3f99872)
• theme: align docsearch breakpoints with the default theme (90c28d4), closes #​5213
• theme: align local search breakpoint (#​5217) (a425113)
• theme: correct anchor scroll margins across viewports (dabc5e9)
• theme: ensure outline marker follows click (#​3879) (31287c0)
• theme: external link icon not showing in navbar links (225c94a), closes #​5306
• theme: pass target and rel to prev/next page links (#​5297) (6b5e770)
• theme: preserve url params when switching languages (#​5312) (9ee401d)
• theme: prevent TypeError when navigating to page without outline (#​5329) (9376c58)
• theme: remove font-synthesis style (#​5309) (c34769c)
• theme: safari not showing external link icon properly (7118402)
• theme: rebuild the base styles on tailwind's preflight (f1ee913)
• theme: route cjk punctuation to matching system fonts (91b06b6)
• theme: remove deprecated disableDetailedView local search option (cec4998)
• theme: remove deprecated lastUpdatedText option (18d1b47)
• theme: remove deprecated outlineTitle option (95c0420)
• types: declare Badge as a global component (ca8ba5b)
• types: import EnhanceAppContext from package entry in theme.d.ts (8ff1f3e), closes #​5156

Features

• add web-types.json for JetBrains IDE support (1d448c9), closes #​5157
• auto-add width/height to local images to avoid layout shift (#​5311) (3868b64)
• client: declare $frontmatter and $params as ComponentCustomProperties (0535009)
• client: declare Content and ClientOnly components as GlobalComponents (#​5156) (6629577), closes #​5154
• cli: show vite version in startup log (#​5328) (4666fc2)
• enable metaChunk by default (#​5325) (8e42f31)
• init: use async fs in scaffolding (38b59f9)
• markdown: accept booleans for plugin options (c2be0bf)
• markdown: add region marker engine (b303dd3)
• markdown: allow disabling table tabindex attribute (bffe1e1)
• markdown: support disabling built-in markdown plugins (b8d9c8f), closes #​4484 #​4556
• markdown: support footnotes (430a890)
• markdown: support GitHub-style task lists (97f8781), closes #​413 #​1923 #​3648 #​5110
• markdown: support per-locale markdown strings (faaa4a1), closes #​4431
• markdown: support registering custom containers (962f00e), closes #​3591 #​3603 #​4228
• markdown: support title-less containers (4c7a030), closes #​4928 #​4932 #​4929
• markdown: rebase relative urls in included files (6a337ef)
• markdown: group code copy button strings into one option (2fa0ded), closes #​4431
• markdown: replace markdown-it-attrs with @​mdit/plugin-attrs (18380b0)
• markdown: replace markdown-it-emoji with @​mdit/plugin-emoji (018887f)
• markdown: replace markdown-it-anchor with @​mdit/plugin-anchor (7550517)
• markdown: support attrs: false for disabling attrs plugin (e235dbe)
• markdown: support note, important, caution markdown containers (#​5161) (3b560a0), closes #​4427 #​3928
• theme: allow internal social links (51ff681), closes #​5305
• theme: cover all Inter glyphs, generate font subsets from a script (705c1be)
• update option stability annotations (ab1896f)

Performance Improvements

• build: reuse lastUpdated from markdown rendering in sitemap generation (fdd68e3)
• md: bypass gray-matter's unbounded cache (4f8703d)
• md: limit the compile cache's memory usage (2fb6bda)
• use hook filters in vite plugins (fa24c6d)

Reverts

• Revert "fix: prevent DocSearch SVG clipping in WebKit" (#​5304) (c8313a4), closes #​5304 #​5240

BREAKING CHANGES

• markdown.anchor options are now typed by @mdit/plugin-anchor. Common options (level, slugify, permalink, getTokensText, tabIndex, etc.) are unchanged, but the deprecated markdown-it-anchor permalink options (permalinkSymbol, renderPermalink, ...) are no longer accepted. Permalink builders like headerLink are named exports of @mdit/plugin-anchor instead of properties of the plugin.

• markdown.attrs options are now typed by @mdit/plugin-attrs: leftDelimiter, rightDelimiter, and allowedAttributes are renamed to left, right, and allowed. A rule option is available for toggling individual attribute rules (VitePress disables fence by default).

• markdown.codeCopyButtonTitle is now markdown.codeCopyButton.tooltipText, and its default changed from "Copy Code" to "Copy code". The --vp-code-copy-copied-text-content CSS variable and its built-in per-language :lang() defaults are removed - set codeCopyButton.copiedText (per locale) instead.

• useData().hash has been removed. Read the hash from useRoute() instead.

• callers of vitepress' build() will now notice the version banner gets printed. To disable that, pass a noop function:

  build(root, {
    onAfterConfigResolve() {}
  })

• custom themeConfig.i18nRouting functions now receive the current Route as their second argument instead of the hash

• normalize-level defaults differ from the old reset - native select and number-input chrome is restored, headings inherit font size and weight, the hidden attribute is enforced with !important, and every element starts with zero margin/padding and border-style: solid. Sites layering custom CSS on the default theme may notice.

• relative urls in included markdown files resolve against the included file rather than the including page. Partials written for one specific location may need their links updated, or markdown.include.rebaseRelativeUrls set to false to keep resolving them from the including page. Absolute and external urls are unaffected. Note that the marker comments shift the line numbers reported for dead links following an include, which already pointed into the include-expanded source rather than the original file.

• init: scaffold() now returns a Promise<string> and must be awaited.

• The defs property of markdown.emoji has been renamed to definitions.

• The markdown.attrs.disable option has been removed. Set markdown.attrs to false instead.

• The markdown.image.lazyLoading option has been renamed to markdown.image.lazyLoad.

• The deprecated disableDetailedView option of local search has been removed. Use detailedView: false instead.

• The deprecated markdown.cjkFriendly option has been removed. Use markdown.cjkFriendlyEmphasis instead.

• The deprecated themeConfig.lastUpdatedText option has been removed. Use themeConfig.lastUpdated.text instead.

• The deprecated themeConfig.outlineTitle option has been removed. Use themeConfig.outline.label instead.

• The Inter4CJK font family has been renamed to 'Inter Core'. Custom --vp-font-family-base overrides referencing Inter4CJK must be updated.