You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
vitepress/CHANGELOG.md

136 KiB

1.0.0-alpha.75 (2023-04-30)

Bug Fixes

  • build: reset regex lastIndex before testing (188893c)
  • cli/init: remove trailing slash from npm scripts (64ecedc)
  • theme: hide local nav on home page (f07587a), closes #2312
  • theme: local search get 404 on build when use route rewrites in windows (#2301) (494c634)
  • theme: vitepress data not properly injected in app when use localSearch (#2299) (69c7646)

Features

BREAKING CHANGES

  • theme: Styling for code blocks might break, especially if you were earlier overriding it for light theme. Those workarounds are no longer required. VitePress will now show code blocks and groups in light mode too if a light shiki theme is specified.

1.0.0-alpha.74 (2023-04-24)

Bug Fixes

  • build: allow data-loaders files in packages to be found (closes #2272) (84cf457)
  • router: scroll back to the hash anchor even if it is already selected (#2265) (f3d3332)

Features

  • allow using html in member description (#2269) (f744364)
  • search: support custom disableQueryPersistence in local search (#2273) (2f0f2d5)
  • theme: mobile view show outline button after removing sidebar (#2274) (25b9111)

1.0.0-alpha.73 (2023-04-20)

Bug Fixes

  • search: fix highlighting in detailed view (1f4920c)
  • search: local search showDetailedList not working in windows (#2253) (09be057)

Features

1.0.0-alpha.72 (2023-04-17)

Bug Fixes

  • search: don't directly access userConfig (3e0e9d2)
  • search: ready event is not fired on mac (e37e5cb)
  • theme: local search showDetailedList not working in windows (#2248) (8354f8f)

1.0.0-alpha.71 (2023-04-16)

Bug Fixes

  • search: esm interop mark.js import (1b0a249)
  • search: properly group nested headings (b1c956c), closes #2238

1.0.0-alpha.70 (2023-04-16)

Bug Fixes

  • a11y: increase touch target size of search icons (4449867)
  • search: avoid body scroll when using local search (#2236) (144a7d8)
  • search: better highlighting in detailed view (#2234) (be83524)
  • search: fix keyword highlighting and scrolling in excerpts (ca8db8a)
  • search: remove double base on importing excepts (185213c), closes #2230
  • search: remove extra /index from routes (9e04b43)
  • search: show escape to close on footer (6d5b4cd)

Features

  • search: allow force disabling detailed view (40f1d1b)
  • search: make styling more configurable, align more with the theme (#2233) (b2077c7)

1.0.0-alpha.69 (2023-04-15)

Bug Fixes

  • search: fix errors on empty titles (6d363ec)
  • theme: fix color of blockquote in custom containers (#2173) (712a57f)

1.0.0-alpha.68 (2023-04-15)

Bug Fixes

  • theme: fix top of scrollbar being unusable (#2224) (7178a22)

1.0.0-alpha.67 (2023-04-15)

Bug Fixes

Features

  • allow passing props and children/slots to defineClientComponent (#2198) (4c24960)

1.0.0-alpha.66 (2023-04-15)

Bug Fixes

  • search: properly resolve page link (609d447)
  • theme: fix meta key not showing on search button (e295160)

Features

1.0.0-alpha.65 (2023-04-04)

Bug Fixes

  • build: remove extra line at end of code blocks (#2191) (a681fd1)

1.0.0-alpha.64 (2023-03-29)

Bug Fixes

  • build: make lastUpdated work with git submodules (#2149) (4c23003)
  • theme: fix color of table head row in custom containers (#2160) (51ecd58)
  • theme: hide outline dropdown scrollbar when it does not overflow (#2151) (ff26ff1)

Features

  • build: provide siteConfig in transformPageData context (#2163) (3714741)
  • theme: add page-top/bottom and doc-top/bottom slots (#2139) (53d0099)
  • theme: allow moving aside to left (#2138) (9e3cf0f)

1.0.0-alpha.63 (2023-03-26)

Bug Fixes

  • theme: allow adding html as feature icons (e5bc1e1)
  • theme: remove label background of code-group tabs (#2136) (eac03f2)

Features

1.0.0-alpha.62 (2023-03-25)

Bug Fixes

  • make md includes work with rewrites (#1898) (3553f01)
  • theme: don't show outline when no header is there (#2117) (42a0ef2)
  • theme: fix aside position when footer is there (#2115) (aecdeb9)
  • theme: properly align not found icon in algolia (#2116) (83ce1b8)
  • theme: use locale lang instead of navigator lang for last updated (#2118) (56a7d9a)

1.0.0-alpha.61 (2023-03-20)

Bug Fixes

  • build: skip warning for txt language (#2109) (ac953ce)
  • decode when query selecting current hash (1f2f1ff), closes #2089
  • theme: prevent code-groups conflict with shiki-twoslash (#2059) (ee6cda4)

1.0.0-alpha.60 (2023-03-15)

Features

  • support multiple selectors for scrollOffset (86e2a6f)
  • theme: add animation to mobile page outline dropdown (a6b18a8)

1.0.0-alpha.59 (2023-03-15)

Bug Fixes

  • handle async enhanceApp when extending themes (52b04f3)
  • theme: improve Chinese font handling (81ae1c7), closes #2036
  • theme: move doc-footer-before slot into the footer (b0160bc), closes #2082

Features

  • defineClientComponent helper (2ad668c)

1.0.0-alpha.58 (2023-03-14)

Bug Fixes

  • fix optional component imports from default theme (7b0f289)

1.0.0-alpha.57 (2023-03-14)

Bug Fixes

  • types: allow void return in transformHead hook (32dfaf5)

Features

  • expose page and assets on build hooks TransformContext (468c049)
  • theme: a11y improvements (3b6a6d1)
  • theme: aria-label for social links (6ca34c4)
  • theme: page outline for mobile (7182c42)
  • theme: support extending default theme without importing fonts (da1691d)
  • theme: use more accessible header anchors #2040

Performance Improvements

BREAKING CHANGES

  • markdown.headers is now disabled by default. This means PageData will no longer include extracted headers by default unless this option is explicitly enabled. This is because the default theme now extracts page headers at runtime, so the data is no longer needed by default.

1.0.0-alpha.56 (2023-03-13)

Bug Fixes

  • do not include head tags in inlined site data (2f26693)

1.0.0-alpha.55 (2023-03-13)

Bug Fixes

  • fix scroll to hash on new tab during dev (9aafc88), closes #653
  • gracefully handle config update with syntax error (470ce3d), closes #2041

Performance Improvements

  • inline site data on page (22ace7b)
  • kickoff main chunk fetch earlier in browsers without modulepreload support (d64a76e)

1.0.0-alpha.54 (2023-03-13)

Bug Fixes

1.0.0-alpha.53 (2023-03-13)

Bug Fixes

Features

1.0.0-alpha.52 (2023-03-11)

Bug Fixes

  • fix line higlighting for empty lines (9708510)
  • fix rewrites with non ascii chars (6ce88da), closes #2017
  • fix same page hash links with encoded chars (e05a3f2), closes #1749
  • properly serialize header in outline (8ab36d0)
  • remove @vue/devtools from force include (9bd940f)
  • respect user vue alias (63f33d2), closes #1065
  • theme: re-support dynamic headers (657a7d3)
  • trim spaces from outline headers (9ceff1d)

Features

  • allow disabling markdown.headers (868a9ff)

Performance Improvements

  • improve default theme chunking (f6cb4c0)

BREAKING CHANGES

  • default theme config option outlineBadge has been removed. Badges in headers are now always excluded when generating outline text.

1.0.0-alpha.51 (2023-03-09)

Bug Fixes

Features

Performance Improvements

1.0.0-alpha.50 (2023-03-07)

Bug Fixes

  • avoid deprecation warning when using --force (0c0b6cc)
  • ensure HMR works properly for page outline (1457681), closes #1281
  • extract all headers by default (580a8e1)
  • respect command line minify and outDir options (22047f3)
  • theme: make tip box text color darker (3158115)
  • theme: prevent text wrapping in nav dropdown menu (2a1abbe)

Features

  • data-loader: defineLoader() type helper (4673bb1)
  • data-loader: pass watched files into load() (e29b6a0)
  • deprecate Theme.setup (868a586)
  • export loadEnv from vite (7609704)
  • expose isNotFound on PageData, deperecate Theme.NotFound (74caccd)
  • expose params at top level in useData() (66f94fd)
  • support $params in page components (a4ac055)
  • support Theme.extends (f39b6a9)
  • theme: add as prop to Content (#2011) (254e15b)
  • theme: add home-hero-info slot (#1807) (996a5f4)
  • vitepress init command (#2020) (38bbdad), closes #1252

1.0.0-alpha.49 (2023-02-28)

Bug Fixes

  • disable fuzzy link recognition by default (2450710)
  • dyamic routes w/ srcDir + relative imports (b075ee5)
  • hmr on deps change of data loaders (5913ebc)
  • normalize all paths in config (8e8fcd9)
  • theme: "copy code" button not readable on hover state (#819) (#1892) (#1998) (c2de4ca)
  • theme: tip custom container has wrong bg color for <code> block (d9a2e6e)
  • update route configs on file add / delete (bccce98)

Features

1.0.0-alpha.48 (2023-02-26)

Bug Fixes

Features

  • build: add support for custom languages (#1837) (5a6d384)
  • theme: make prev/next links changeable (#1972) (b8a5e8e)
  • theme: support custom target and rel in navbar links (#1993) (e2d4edf)

1.0.0-alpha.47 (2023-02-20)

Bug Fixes

Reverts

  • "docs: add linkage for code-groups in getting-started" (#1943) (ed90724), closes #1906

1.0.0-alpha.46 (2023-02-12)

Bug Fixes

  • build: prepend base to all internal non-relative links (#1908) (dcf2941)
  • theme-default: avoid preconnect without algolia (#1902) (616fe5b)
  • theme-default: remove duplicate judgments in preconnect() (#1903) (48c9b11)
  • theme: make features support line wrapping (#1913) (ea43076)

Features

BREAKING CHANGES

  • build: base is now prepended to all internal (non-relative) links, including any reference to a file present in the public directory. If you want the earlier behavior for such links, use absolute links.

1.0.0-alpha.45 (2023-01-31)

Bug Fixes

1.0.0-alpha.44 (2023-01-31)

Bug Fixes

Features

BREAKING CHANGES

  • theme: collapsible is dropped from sidebar, use collapsed instead

1.0.0-alpha.43 (2023-01-29)

Bug Fixes

  • build: hmr with rewrites when base is set (a05956f)

1.0.0-alpha.42 (2023-01-29)

Bug Fixes

  • build: consider base when checking actual pathname (#1858) (cf8ad1a)

1.0.0-alpha.41 (2023-01-28)

Bug Fixes

  • check document instead of window to detect browser (#1833) (0f145cb)
  • router: avoid duplicate history entries (#1827) (1553dbc)
  • theme: don't show border on navbar when sidebar is there (#1845) (3db532e)

Features

1.0.0-alpha.40 (2023-01-20)

Bug Fixes

  • theme: nav bg not being applied on some viewport (39294e0)

1.0.0-alpha.39 (2023-01-20)

Bug Fixes

  • theme: adjust the position of the curtain to avoid block sidebar (#1816) (48f0b01)
  • theme: sidebar scrollbar is cropped by nav bar (bd36224)

1.0.0-alpha.38 (2023-01-17)

Bug Fixes

  • theme: spacing between aside sponsors and ads section is missing (5c2eb1b)

1.0.0-alpha.37 (2023-01-17)

Bug Fixes

  • build: don't warn on blank lang in fences (99ad162)
  • theme: prevent vertical scrollbar on code group tabs (#1793) (#1805) (4314b57)

Features

1.0.0-alpha.36 (2023-01-11)

Bug Fixes

Features

  • allow enhanceApp to return a Promise (#1760) (01ac579)
  • build: support interpolation inside code blocks (#1759) (3b7ff8d)

1.0.0-alpha.35 (2023-01-03)

Bug Fixes

  • theme: adjust styles for copied button (#1751) (565ae71)
  • theme: adjust styles for diff indicator in code blocks (#1755) (a642ea2)
  • theme: prevent layout shift on carbon ads (f6c5e1f)
  • theme: refresh ads per page navigation (#1734) (8db20fe)

1.0.0-alpha.34 (2023-01-01)

Bug Fixes

  • build: dedent of a single-line region (#1687) (7de7fff)
  • build: handle - in title of code blocks with line highlighting (#1743) (ce9467e)
  • handle cleanUrls with subfolders when using a trailing slash (#1575) (195d867)

Features

  • build: allow specifying default language for syntax highlighter (#1296) (f40df31)
  • build: fence-level config for line-numbers (#1733) (c048076)
  • theme: add home-hero-image slot (#1528) (e72998b)
  • theme: add mastodon icon (#1736) (7a73784)
  • theme: allow adding images as icons in features section (#1738) (9df598f)

Performance Improvements

  • a11y: make menu traversable only when it is open (#1491) (257f9e6)
  • preload css to improve loading speed (bf1315a)

1.0.0-alpha.33 (2022-12-21)

Bug Fixes

Features

  • build: provide a pathname:// protocol to escape SPA (#1719) (ae21a3a)
  • theme: headings anchor should not be selectable (#1701) (505a4f8)

1.0.0-alpha.32 (2022-12-16)

Bug Fixes

  • build: fix code groups for line numbers mode (#1700) (135b797)

Features

1.0.0-alpha.31 (2022-12-10)

Features

Performance Improvements

  • a11y: add aria-hidden to line numbers wrapper (#1675) (4c5a892)

1.0.0-alpha.30 (2022-12-05)

Bug Fixes

  • build: allow importing files having numbers in extension (#1618) (0565c38)
  • build: allow serving files in dev from workspace root (#1647) (dc59662)
  • theme: default to vertical align top on badges inside headings (#1584) (8a488de)
  • theme: ignore removed diff lines while copying code (f4d5417)
  • theme: move background colors to theme-default style (#1347) (4f0194f)

Features

  • build: add preview as an alias for serve in cli (#1651) (4ba33da)

1.0.0-alpha.29 (2022-11-15)

Bug Fixes

  • build: explicitly specify asset and entry file names (#1607) (8601e15)
  • theme: typo in attribute name (#1597) (cc91d55)

1.0.0-alpha.28 (2022-11-08)

Bug Fixes

  • theme: use faux italics only with web fonts (#1581) (124158e)

Features

1.0.0-alpha.27 (2022-11-03)

Bug Fixes

  • build: use addClass from shiki-processor (#1557) (4b0b1ef), closes #1555
  • build: use default slugify from mdit-vue (#1554) (8cd1f7c)
  • prevent overlay getting hidden behind navbar (#1547) (87d6c08)
  • remove shell code copy trailing newline (#1561) (f36cd0d)
  • theme: use stored preference to be the value of userPreference (#1543) (a7abf73)

Features

Reverts

1.0.0-alpha.26 (2022-10-27)

Bug Fixes

  • properly apply dark/light classes in code blocks (#1546) (178895f)

1.0.0-alpha.25 (2022-10-25)

Bug Fixes

  • banner: prevent hidden local nav on scroll (63449ca)

1.0.0-alpha.24 (2022-10-25)

Bug Fixes

  • banner: broken layout on smaller viewports (#1536) (028cc2c)

1.0.0-alpha.23 (2022-10-25)

Bug Fixes

  • build: explicitly exit process after build to prevent hangup (#1530) (09fcc46)

Features

  • build: add useWebFonts option (#1531) (c9f04e0)
  • support focus, colored diffs, error highlights in code blocks (#1534) (04ab0eb)
  • theme: add --vp-layout-top-height to adjust banner (#1521) (a29a4a6)

1.0.0-alpha.22 (2022-10-22)

Bug Fixes

  • types: change ComponentOptions to DefineComponent (#1499) (5711660)

Features

1.0.0-alpha.21 (2022-10-14)

Bug Fixes

  • build: better align server and client side filename sanitization (3fd20fe)
  • theme: match switch background transition with page transition (#1479) (962065a)
  • theme: prevent body scrolling when sidebar has opened on small screens (#1391) (3daabdc)

Features

  • theme: allow specifying common alt for logo (#1451) (55688a8)

1.0.0-alpha.20 (2022-10-12)

Bug Fixes

Reverts

  • "fix(build): remove leading underscore from chunks" (#1471) (18f0fb4)

1.0.0-alpha.19 (2022-10-02)

Bug Fixes

1.0.0-alpha.18 (2022-10-01)

Bug Fixes

1.0.0-alpha.17 (2022-09-27)

Bug Fixes

  • theme: add cursor for collapsible sidebar title (#1397) (ed37b9a)
  • theme: remove extra space before docsearch key (#1396) (6cb79bb)

Reverts

1.0.0-alpha.16 (2022-09-24)

Bug Fixes

  • build: line numbers mode when language specifier has symbol (#1353) (9c04a10)
  • build: remove leading underscore from chunks (#1394) (66cd164)
  • compat: use default export of dns module (#1388) (fa6fa56)
  • theme: always add alt attribute to images (#1348) (a621c69)

Features

1.0.0-alpha.15 (2022-09-15)

Bug Fixes

1.0.0-alpha.14 (2022-09-14)

Bug Fixes

  • prevent jumping on clicking docsearch action buttons (#1140) (86413e6)
  • theme: break long words (#1064) (9c739fd)
  • theme: don't nest sidebar links (#1279) (f840dbc)
  • theme: keep display copied hint when click multiple times (#1262) (bb11d0f)
  • theme: show progress bar after delay (#1278) (496bd34)
  • theme: use pointer cursor only on enabled buttons (#1300) (d7eac98)
  • theme: use pointer-events auto instead of all (#1290) (6fac5b2)
  • types: allow non async transformHtml and buildEnd (#1270) (ee37eaa)

Features

Performance Improvements

Reverts

1.0.0-alpha.13 (2022-08-30)

Features

  • use global delegation for copy code interaction (b5bd73f)

1.0.0-alpha.12 (2022-08-26)

1.0.0-alpha.11 (2022-08-26)

Features

1.0.0-alpha.10 (2022-08-22)

Bug Fixes

  • avoid circular deps when extending default theme + importing feature components (5fb7948), closes #1210

Features

  • build: support markdown frontmatter options (#1218) (bfb0220)

1.0.0-alpha.9 (2022-08-20)

Bug Fixes

  • theme: fix typo in carbon ads components (#1192) (e0932ce)
  • theme: show footer message/copyright only if present (#1191) (da2f8d2)
  • theme: show outline even without sidebar (#1189) (3714ea3)
  • types: explicitly re-export to resolve ambiguities (#1193) (eacc18c)
  • use junctions in Windows (#1217) (0e14211)

Features

  • theme: extend titleTemplate by replacing the title (#1200) (c7def73)

1.0.0-alpha.8 (2022-08-17)

Bug Fixes

1.0.0-alpha.7 (2022-08-17)

Bug Fixes

  • fix static data file support in vite 3 (19ec22c)

1.0.0-alpha.6 (2022-08-17)

Breaking Changes

  • /@theme import alias has been removed. Use @theme instead.

Bug Fixes

  • theme: remove extra padding in code blocks with line numbers (f6d6c62)
  • theme: restore styles for code blocks (#1170) (2c89afb)
  • theme: set pointer events all on VPNavScreen (#1182) (b36656a)

Features

  • build: switch to vite 3, support clean urls and esm mode (#856) (0048e2b)

1.0.0-alpha.5 (2022-08-16)

Bug Fixes

Features

Performance Improvements

Reverts

1.0.0-alpha.4 (2022-06-22)

Bug Fixes

  • theme: home image style is broken in big view port (2bd960d)

1.0.0-alpha.3 (2022-06-22)

Bug Fixes

  • theme: italic fonts are missing (#759) (#777) (fa00c83)
  • theme: copy code in non-secure contexts (#792) (2935ed2)
  • theme: copy code button has wrong tag closing syntax (#816) (75ca9e4)
  • theme: edit link gets hidden when a page don't have siblings (#751) (9bc4330)
  • theme: nav close icon not working correctly (#744) (75c9d80)
  • theme: sidebar is shown on home layout (#825) (#829) (42cbd31)
  • theme: sidebar collapsed option not working on layout change (#809) (#811) (7737699)
  • theme: DefaultTheme type causes error in some cases (#804) (107724a)

Features

  • build: allow setting base from command line (2952638)
  • theme: add active status to nav menu group (#820) (fdb5720)
  • theme: add global layout slots (#760) (#812) (1f1e298)
  • theme: support themeable images for logo and hero (#745) (42813ce)
  • theme: add team page feature (#828) (7cfe0f0)

1.0.0-alpha.2 (2022-06-14)

Bug Fixes

Features

1.0.0-alpha.1 (2022-06-01)

Complete rewrite on default theme, with bunch of features added. Please refer to the docs for the new feature and changes.

0.22.4 (2022-05-06)

Bug Fixes

  • plugin: set content-type header for serving index.html (#616) (1656f03)
  • remove 404 from title on initial route (#590) (216e129), closes #589

0.22.3 (2022-02-22)

Bug Fixes

0.22.2 (2022-02-14)

Features

  • improve default chunk strategy + page hash stability (1ef69e2)

0.22.1 (2022-02-14)

Features

  • automatically update hash map + retry on failed page fetch (2324948)

  • use git-based lastUpdated data (d32d8d4)

    Note: lastUpdated data is now disabled by default due to the performance overhead of retrieving the git information. This also means each page's metadata object no longer contains the lastUpdated property by default - it will only be present if the new lastUpdated: true config option is enabled.

0.22.0 (2022-02-11)

  • Upgrade to Vite 2.8

0.21.6 (2022-01-19)

Perf

  • Avoid wrapping siteData as readonly proxy in production builds

0.21.5 (2022-01-16)

Bug Fixes

Features

0.21.4 (2022-01-07)

Bug Fixes

  • set __data in md.render (dfbc932)

0.21.3 (2022-01-06)

Bug Fixes

  • prioritize vue installed in user project root (9b3243b)

0.21.2 (2022-01-06)

0.21.1 (2022-01-06)

Performance Improvements

  • do not include head config in client bundle for production (6f3a96f)

0.21.0 (2022-01-06)

Bug Fixes

Features

  • add details custom container (#455) (a8f147f)
  • catch localhost links as dead links (7387649)
  • expose __path and __relativePath on md instance for md plugins (4cec660)
  • improve typescript support for config file, add defineConfigWithTheme (#465) (ba41bb9)
  • properly remove {#custom-anchor} syntax in headers (6120da2)
  • user configurable outDir (#448) (5b04bb9)

0.20.10 (2021-12-25)

Features

  • minify head inline scripts (e61db62)

0.20.9 (2021-12-15)

Features

  • shouldPreload hook (e721d60)
  • support array of patterns in data loaders (f5308d7)

0.20.8 (2021-12-14)

0.20.7 (2021-12-14)

Features

  • types: re-export vite client type (4caa7b2)

0.20.6 (2021-12-14)

Features

  • support static data loaders (26fe81c)

0.20.5 (2021-12-12)

  • Bump vue & vite versions

0.20.4 (2021-12-07)

Bug Fixes

  • build: fix typing files (ae11dc0)

0.20.3 (2021-12-07)

Features

  • expose createMarkdownRenderer (d54c7d8)

0.20.2 (2021-12-06)

Bug Fixes

  • handle potential string quote mismatch in generated code (dfa7c05)
  • improve createStaticVNode match for rollup codegen compat (abb1b57)
  • lazy require @vitejs/plugin-vue to respect NODE_ENV (a051e66)
  • static string strip regex for mulitiline static strings (bc486aa)

Features

0.20.1 (2021-11-05)

Bug Fixes

  • hmr: avoid relying on revertd vite hmr behavior (4114674)

0.20.0 (2021-10-07)

Bug Fixes

  • fix code line hightlighting (4c042b6), closes #408
  • invalid active props when base option is added (#342) (383d8ff)
  • make config hmr work in window (#364) (58663bb)
  • print urls again (df69b76)
  • support vite plugins provided via config.vite (#394) (4b76617)
  • theme-default/algolia: avoid creating multiple algolia searches (#292) (389e863)
  • theme: fix algolia search filter (5fd7db2)
  • tolerant invalid hash (#399) (efc5e1b)

Features

  • support ts/esm config file + defineConfig() helper (d3b1521), closes #339 #376
  • theme-default: home slot for customizing the entire homepage easily (#314) (07bf145)

0.19.2 (2021-09-28)

Bug Fixes

  • encode urls that conflict w/ vite built-in replacements (3940625)

0.19.1 (2021-09-21)

  • Fix build

0.19.0 (2021-09-21)

Features

  • upgrade vue, simplify deps (9030486)
  • use markdown-it-attrs for markdown-it plugins (#393) (610e9b7)

0.18.1 (2021-09-16)

Bug Fixes

  • ensure stable pages entry order across builds (929bcf5)

0.18.0 (2021-09-14)

Features

  • map mode + remove deprecated options (b94b163)
  • support <script client> in mpa mode (e0b6997)

0.17.3 (2021-09-09)

Bug Fixes

  • emit prevented hashchange event (4fb387d)

0.17.2 (2021-09-08)

Bug Fixes

Features

0.17.1 (2021-09-08)

Bug Fixes

  • avoid using spread for client code (03abee7)
  • default-theme: use description as tagline by default (b94c827)
  • handle case when there is no themeConfig (034c737)

Performance Improvements

0.17.0 (2021-08-31)

Bug Fixes

Features

BREAKING CHANGES

  • the markdown.anchor option is updated. Refer to valeriangalliat/markdown-it-anchor#permalinks for instructions to upgrade your existing markdown.anchor.permalink option. This doesn't affect you if you weren't changing the header permalinks behavior.

0.16.1 (2021-08-11)

Features

0.16.0 (2021-08-10)

This version uses Vue 3.2.0.

Bug Fixes

  • override target and rel links attribute in config (#332) (9d98dbb)
  • edit-link: let frontmatter overwrite global editLink (#340) (cfbba80)

0.15.6 (2021-07-02)

Bug Fixes

  • automatically escape vite user defined variables in markdown (3cec536)
  • skip external URLs in withBase (#328) (53bb961)

0.15.5 (2021-06-23)

Bug Fixes

  • nav: display nav if locales are present (#321) (e76e6ec)
  • search: correctly detect multilang (c046905), closes #316

Performance Improvements

  • only update necessary head tags in prod (e6bb5a4)

0.15.4 (2021-06-19)

Bug Fixes

  • avoid scroll behavior reliance on .nav-bar class (9b35dfc)

0.15.3 (2021-06-15)

Bug Fixes

  • avoid error when theme does not have .nav-bar class (a9d5800)
  • avoid resetting head tags on hmr/page switch (f52f20e)
  • watch config file when using srcDir (348f19a)

0.15.2 (2021-06-15)

Bug Fixes

  • force optimize vue to avoid duplication when linked (eefba39)

0.15.1 (2021-06-14)

Features

  • support passing vite config in vitepress config file via vite option (3737b10)
  • support srcDir config option (aaf4910)

Performance Improvements

  • avoid double resolve user config on startup (5733fc6)

BREAKING CHANGES

  • Some config options have changed.

    • vueOptions renamed to vue
    • alias option has been removed. Use vite.resovle.alias instead.

0.15.0 (2021-06-14)

Bug Fixes

  • fix frontmatter sidebarDepth for headers (424a4ca)
  • fix vue code block type indication (76fa173)

Features

  • more efficient useData() method that exposes all data (0661063)

BREAKING CHANGES

  • The following methods are removed.

    • useSiteData
    • useSiteDataByRoute
    • usePageData
    • useFrontmatter

    Instead, use the new useData() method:

    // before
    import { useSiteDataByRoute, usePageData } from 'vitepress'
    const site = useSiteDataByRoute()
    const page = usePageData()
    const theme = computed(() => site.value.themeConfig)
    
    // after
    import { useData } from 'vitepress'
    const { site, page, theme } = useData()
    

    All destructured values are computed refs injected from app root so they are created only once globally.

  • All global mixin properties (e.g. $site) except $frontmatter are removed. Always use useData() to retrieve VitePress data in Vue components.

0.14.1 (2021-06-08)

Bug Fixes

0.14.0 (2021-05-27)

Bug Fixes

  • chinese filenames can't build (#217) (#262) (b940397)
  • theme: set search box min-width for >=751px (#286) (9589a5d)
  • detect public folder for dead link (#290) (3aa185f)
  • remove unnecessary 'vite/dynamic-import-polyfill' (6b4a4aa)

Features

  • Vite version bumped to ^2.3.4
  • exclude option (#281) (71a5e1c)
  • Render titles for social sharing and improve home page sharing (#263) (e651f97)

0.13.2 (2021-04-26)

Bug Fixes

  • search: silence warning for prop (0716ffa)

0.13.1 (2021-04-26)

Bug Fixes

0.13.0 (2021-04-08)

Bug Fixes

Features

0.12.2 (2021-02-15)

Bug Fixes

  • theme-default: avoid ad image distortion on mobile (4a40e1f)

0.12.1 (2021-02-15)

Bug Fixes

  • @ alias for import code snippet being always undefined (#204) (2aa8ab2)
  • base option not generating correct multi sidebar (#231) (#234) (a613df4)
  • ads display causing layout break in mobile view (#230) (7ceaf34)
  • home action link not being reactive (#195) (#212) (5678dc3)
  • nav home title not having locale based link (#195) (#233) (6538c8e)

0.12.0 (2021-02-09)

Bug Fixes

Features

  • add vue options config (expose @vitejs/plugin-vue) (#215) (5b34c6a)

BREAKING CHANGES

  • If sidebar option is undefined it will be treated as auto, where previsouly it looked like it was treated as false. It was always treated as auto, but due to this bug, the sidebar was hidden, therefore it looked like it was treated as false.

0.11.5 (2021-01-29)

Bug Fixes

Features

0.11.4 (2021-01-19)

  • Latest Vite beta.32 compat (internal changes).

0.11.3 (2021-01-13)

Bug Fixes

  • ignore non-html links in router and prefetch (3e6e61b)

0.11.2 (2021-01-12)

Bug Fixes

Performance Improvements

  • generate preload directives for dynamicImport chunks too (b9fc0cb)

0.11.1 (2021-01-12)

Features

  • render content on home page (ca631c7)

0.11.0 (2021-01-12)

Code Refactoring

  • move default theme to 'vitepress/theme' (a79e1e1)

Features

  • support customData in config (4072dc5)

BREAKING CHANGES

  • the default theme is now exposed via 'vitepress/theme', instead of a named export from 'vitepress'. This change fixes the case where when a completely custom theme is used, importing anything from 'vitepress' also imports the entire default theme.

0.10.8 (2021-01-11)

Bug Fixes

0.10.7 (2021-01-05)

Features

Bump to Vite 2.0.0-beta.8

Bug Fixes

0.10.6 (2021-01-04)

Bug Fixes

  • bump vite and fix win32 path resolving (#198) (da2c4f6)

0.10.5 (2021-01-02)

Bug Fixes

  • vite 2.0.0-beta.2 compat (991a443)

0.10.4 (2021-01-01)

Bug Fixes

  • ensure the same vue dep in all cases (d6b8568)
  • respect root during build (055e3fd)

0.10.3 (2021-01-01)

Bug Fixes

  • always define theme globals (8769b4b)
  • avoid unexpected vite define replacements in markdown content (a41928e)
  • loosen navLink active matching (8a2ff33)

Features

  • theme-default: nav.item.activeMatch (e262ef6)
  • add altAction for home (9a17ddf)

0.10.2 (2020-12-31)

Bug Fixes

  • adjust multi sidebar matching logic (7e4b16e)

0.10.1 (2020-12-30)

Bug Fixes

Features

Performance Improvements

  • avoid including optional features in build when not used (c878e6d)

0.10.0 (2020-12-30)

  • Upgrade to Vite 2.0

Bug Fixes

  • port fixes to parseHeader utils from vuepress (#172) (dd312ce)
  • revert datetime handling (a1daf2b)
  • style pollution on custom theme (#190) (46e99ba)
  • temporarily disable slot usage causing hydration mismatch (0239159)
  • md: avoid normalising markdown "mailto:" links (#173) (18d18d2)

0.9.2 (2020-12-10)

Fix build files

0.9.1 (2020-12-05)

Bug Fixes

Features

  • built-in ClientOnly component (8809d2d)
  • default-theme: support customLayout: true in frontmatter (f32771f)
  • add $withBase global app function (15e18df)
  • add Algolia DocSearch (#40) (#153) (5bb4730)
  • add native support for carbon ads (#86) (9d6b8ca)
  • support customizing default theme via slots (b8e892e)
  • add more global and computed properties (#152) (c6bdcfb), closes #152

0.9.0 (2020-11-24)

Bug Fixes

  • avoid 300ms click delay on touch devices (621ca3e)
  • fix nested list having too much margin (b0cf2be)
  • fix sidebar active status not working as expected (#140) (#149) (0b181e7)
  • make code block look prettier (#146) (242fcc1)
  • some color in code block not working as expected (#143) (da09266)

Features

  • add "last updated" feature (40d204b)

0.8.1 (2020-11-20)

Bug Fixes

  • fix "next and prev link" not working when link has extention (6dcf6b3)
  • fix "next and prev links" not working when the base option is set (#139) (018a9b4)

0.8.0 (2020-11-20)

Bug Fixes

  • exit process with non-zero code on error (fb09f8e)
  • fix edit link and prev and next links display (#97) (c3b7172)
  • fix next and prev links not working (#130) (fdd498b)
  • display header-anchor links when using keyboard navigation (ddc3640)
  • show top part of scrollbar in sidebar (#129) (1ba209a)

Features

0.7.4 (2020-11-11)

Bug Fixes

0.7.3 (2020-11-06)

Bug Fixes

  • Fix sidebar page switch layout shifting
  • Fix production hydration mismatch

0.7.2 (2020-11-02)

Bug Fixes

  • adapt to vite fix of ssr build asset paths (6b3fbe3)

Features

0.7.1 (2020-10-30)

Bug Fixes

  • compat with latest vite + handle no export default script tags in md (b10da2f)
  • fix switch language error (#103, #106) (#104) (d354d1e)

0.7.0 (2020-10-19)

Bug Fixes

  • css: theme specific (6891092)
  • router: remove fakeHost when fixing url extenions (2eb3135)

Features

  • client: add slot for a searchbar (68d9b18)
  • i18n: add nav dropdown language selector feature (#91) (294836c)
  • sidebar: close when navigating (2094d53)
  • add doctype html (02f2e10)
  • add some space between 2 code blocks (5daa8d2)

0.6.0 (2020-09-17)

Bug Fixes

  • client: use relative import (725a04c)
  • links: keep relative hash links as is (a90d971)
  • router: allow open new tab with ctrl + click (#69) (092ee77)
  • sidebar: no margin on mobile (#89) (218c729)
  • sidebar not working correctly when path starts with slash (610cc17)
  • sidebar: fix sidebar when you open a nested link (#73) (d2b6d39)

Features

0.5.0 (2020-07-21)

Bug Fixes

Features

0.4.1 (2020-07-02)

Bug Fixes

  • avoid error when requesting non-existing md file (e77ea63)
  • resolve relative path on windows (#27) (9116c9c)
  • use resolve instead of join (#33) (6f10ed6)

Features

0.4.0 (2020-06-19)

0.3.1 (2020-06-05)

Bug Fixes

  • avoid using DEV + throttle active header link (a63b0cf)

0.3.0 (2020-06-02)

Bug Fixes

  • lazy load @vue/server-render for production build (382e1b6)

Features

0.2.0 (2020-05-22)

Bug Fixes

  • avoid unnecessary prefetches (0a81525)
  • handle links that embed other elements (#2) (4cbfc60)

Features

Performance Improvements

  • inject script tags for page common chunk imports (57d900d)

0.1.1 (2020-04-30)

  • fix dependency versions

0.1.0 (2020-04-30)

Features

  • add markdown processing (5c47bbb)
  • spa navigation (21d3cd8)
  • update head tags during dev (bdbbdd5)
  • update title & description during dev (0b9bf27)