1.0.0-alpha.13 (2022-08-30)
- use global delegation for copy code interaction (b5bd73f)
1.0.0-alpha.12 (2022-08-26)
1.0.0-alpha.11 (2022-08-26)
1.0.0-alpha.10 (2022-08-22)
- avoid circular deps when extending default theme + importing feature components (5fb7948), closes #1210
1.0.0-alpha.9 (2022-08-20)
- 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)
1.0.0-alpha.8 (2022-08-17)
- fix client build entry (04c4d0f)
1.0.0-alpha.7 (2022-08-17)
- fix static data file support in vite 3 (19ec22c)
1.0.0-alpha.6 (2022-08-17)
/@theme
import alias has been removed. Use@theme
instead.
- 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)
1.0.0-alpha.5 (2022-08-16)
- build: cache key should consider file path (#948) (1daeaa1)
- build: handle vite constants replacement (#419) (#888) (9d9db62)
- build: recreate server on config change (#1132) (93fe820)
- build: show workaround on encountering dead links (#822) (#868) (29d44e7)
- build: strip custom anchor with capital letters in outline (#1005) (f6d5697)
- build: update language regex for line number class (#1108) (708c361)
- can't detect that the page has scrolled to the bottom (#956) (#970) (98e45af)
- de-duplicate head tags while merging (#975) (#976) (f7e9cfe)
- decode href before using as query selector (#951) (22006e8)
- decode image src so that rollup can process it (#933) (bb41a9f)
- don't add base to external urls while preloading (#1045) (7295033)
- don't change url hash while scrolling (#991) (0826944)
- layout inconsistencies and remove sidebar from 404 page (#964) (0257ea8)
- line highlighting in custom code block (#959) (#969) (7a9e4d9)
- normalize link in VPButton (#919) (bed68f1)
- only check for duplicate meta tags (#977) (1ef7a18), closes /github.com/vuejs/vitepress/issues/975#issuecomment-1183507200
- regression caused by #887 (30249dc)
- remove duplicate router logic (#1087) (63584c2)
- remove explicit noopener from external links (#871) (e4c60ab)
- support urls with query during dev (35b7361)
- theme: change sponsor link class name to bypass adblock (#866) (#867) (e33955e)
- theme: close menu on route change (#887) (fcd7642)
- theme: don't let navbar obstruct clicks to top part of scrollbar (#1168) (44953dc)
- theme: fix custom NotFound component rendering (#1163) (4a6eda4)
- theme: hide doc footer if empty (#1126) (70da5f2)
- theme: make last updated time reactive (#879) (25a835f)
- theme: navbar menu may exceed the screen (#988) (#989) (8a46413)
- theme: prevent docsearch button key from changing (#986) (d65667b)
- theme: tweak styles of nav title (#962) (#968) (d91f3b1)
- theme: typo in color name (#1020) (4b38736)
- treat all URI schemes as external (#945) (#946) (1e9a7ac)
- types: add client and theme to
exports
field (#914) (1cc087d) - types: fix broken syntax in
theme.d.ts
(#1101) (70b3060) - use
router.go
if search string is not same (#1109) (5597165)
- allow adding custom social icons as inline svg (#738) (#953) (74e4950)
- allow html in footer (#1034) (ad9af83)
- allow using custom syntax highlighting themes (#992) (d5ed66c)
- build: allow ignoring dead links (#586) (#793) (19b0758)
- build: allow using custom highlighter (#754) (#857) (ddf876d)
- build: handle change of config file dependencies (#1009) (8e6665b)
- build: improve code blocks and snippets (#875) (f789932), closes #861 #471 #884
- build: support code highlight in uppercase (#1082) (867f305), closes #772
- provide
transformHtml
hook (#1022) (2b4b800) - provide build end hook (#709) (e0b730a)
- theme: add
doc-footer-before
slot (#1050) (#1052) (60c515c) - theme: add navigation slots (#739) (#741) (0f0453c)
- theme: add option to customize search button text (#713) (#747) (00fe809)
- theme: auto open collapsed sidebar on entering (#1094) (f4f1a6c)
- theme: custom prev/next labels and text (#897) (836a246)
- theme: support hiding aside component from frontmatter (#980) (69ef299)
- theme: support multi-level sidebar (#851) (d1a2c76)
1.0.0-alpha.4 (2022-06-22)
- theme: home image style is broken in big view port (2bd960d)
1.0.0-alpha.3 (2022-06-22)
- 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)
- 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)
- use h1 for title in hero instead of p (#776) (919d230)
- add background color in navbar to avoid contrast issues (#695) (305bcc0)
- add default value for base in
createMarkdownRenderer
(#555) (#556) (78a2e84) - allow lang='ts' on scripts in markdown (#693) (#701) (59df105)
- better nav item types (#714) (263607b)
- double base in sidebar links (#756) (aa65cb5)
- use
pre-wrap
for text and tagline (#746) (94704c9) - nav nested items type error (#710) (#711) (e5bf15a)
- page layout breaks when page name matches the css class name (#696) (#699) (9c0ed93)
- remove title bg transition to avoid flush on sidebar on/off (1942418)
- sidebar right blur notch (#712) (64c3654)
- typo (#708) (#716) (1fe5153)
- title in containers not working with markdown content (#765) (#768) (c5c3c64)
- use base in links (#717) (#718) (8e50154)
- use h2 for feature headers (#774) (b1ff725)
- add
lastUpdated
option to frontmatter (b31fbf3) - add doc before and after slot (#762) (#786) (9c2a36f)
- allow custom edit links (#698) (535e176), closes #694 #697
- allow custom outline title (#689) (#690) (a8a1623)
- allow external links in sidebar (#205) (#686) (ce17f50)
- support custom content in home layout (#702) (92659a2)
- emit 404.html on build (#729) (#740) (23276ba)
- setup devtools and remove debug component (#721) (421f641)
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)
- 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)
- append base to links (#502) (804954c), closes #252
- avoid minimizing non-javascript inline scripts (#517) (779b789), closes #538 #540
- client router: tolerant invalid hash selector typo (#506) (ffe0c40)
- don't add .html to urls of non-html files (#515) (34d1542), closes #265
- normalize relative img src (#514) (9270477), closes #450
- require at least node v14 (#546) (7cf7011)
- reset page data on 404 (#497) (28eaa3b)
0.22.2 (2022-02-14)
- improve default chunk strategy + page hash stability (1ef69e2)
0.22.1 (2022-02-14)
-
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 newlastUpdated: true
config option is enabled.
0.22.0 (2022-02-11)
- Upgrade to Vite 2.8
0.21.6 (2022-01-19)
- Avoid wrapping siteData as readonly proxy in production builds
0.21.5 (2022-01-16)
- allow overriding title if home is true (#493) (88d57a9)
- types: fix vitepress/theme type (eabf6d2), closes #489 #438 #494 #442
- scrollOffset option (b66785d)
0.21.4 (2022-01-07)
- set __data in md.render (dfbc932)
0.21.3 (2022-01-06)
- prioritize vue installed in user project root (9b3243b)
0.21.2 (2022-01-06)
0.21.1 (2022-01-06)
- do not include head config in client bundle for production (6f3a96f)
0.21.0 (2022-01-06)
- Chinese file link build failed (#425) (ae029ae), closes #424
- initial render of 404 pages (#418) (a3bf52f)
- remove
.
for mjs insupportedConfigExtensions
(#447) (fb6a4ad) - serve: respect base config in serve mode (#470) (08a0b12), closes #416
- set tempDir outside package root (#439) (bd35451), closes #435
- use algolia search lang (#459) (444562c)
- 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)
- minify head inline scripts (e61db62)
0.20.9 (2021-12-15)
0.20.8 (2021-12-14)
0.20.7 (2021-12-14)
- types: re-export vite client type (4caa7b2)
0.20.6 (2021-12-14)
- support static data loaders (26fe81c)
0.20.5 (2021-12-12)
- Bump vue & vite versions
0.20.4 (2021-12-07)
- build: fix typing files (ae11dc0)
0.20.3 (2021-12-07)
- expose createMarkdownRenderer (d54c7d8)
0.20.2 (2021-12-06)
- 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)
0.20.1 (2021-11-05)
- hmr: avoid relying on revertd vite hmr behavior (4114674)
0.20.0 (2021-10-07)
- 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)
- 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)
- encode urls that conflict w/ vite built-in replacements (3940625)
0.19.1 (2021-09-21)
- Fix build
0.19.0 (2021-09-21)
0.18.1 (2021-09-16)
- ensure stable pages entry order across builds (929bcf5)
0.18.0 (2021-09-14)
0.17.3 (2021-09-09)
- emit prevented hashchange event (4fb387d)
0.17.2 (2021-09-08)
- improve fs allow (2e9264f)
- support config.extends (f749b27)
0.17.1 (2021-09-08)
- avoid using spread for client code (03abee7)
- default-theme: use description as tagline by default (b94c827)
- handle case when there is no themeConfig (034c737)
- minor optimizations (96bcdda)
0.17.0 (2021-08-31)
- allow vite server access to theme and local files (9b9fdc7)
- code: code block highlight bug in ul (#352) (9245226)
- css: remove 720px breakpoint in home layout (#347) (0c1a1f2)
- i18n: fix locales reading, add site.langs (#353) (bc78adb), closes /vuepress.vuejs.org/guide/i18n.html#site-level-i18 /v2.vuepress.vuejs.org/guide/i18n.html#site-i18
- include emoji text in nav link to match toc (#284) (80ff360)
- use useData() instead of $site (#365) (1e64773)
- support function config (e74c5f0)
- support partial include directive (7b3a9e5)
- upgrade markdown-it-anchor (#350) (26b5aa9)
- the
markdown.anchor
option is updated. Refer to valeriangalliat/markdown-it-anchor#permalinks for instructions to upgrade your existingmarkdown.anchor.permalink
option. This doesn't affect you if you weren't changing the header permalinks behavior.
0.16.1 (2021-08-11)
- info custom container (4925fb5)
0.16.0 (2021-08-10)
This version uses Vue 3.2.0.
- 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)
- automatically escape vite user defined variables in markdown (3cec536)
- skip external URLs in
withBase
(#328) (53bb961)
0.15.5 (2021-06-23)
- nav: display nav if locales are present (#321) (e76e6ec)
- search: correctly detect multilang (c046905), closes #316
- only update necessary head tags in prod (e6bb5a4)
0.15.4 (2021-06-19)
- avoid scroll behavior reliance on .nav-bar class (9b35dfc)
0.15.3 (2021-06-15)
- 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)
- force optimize vue to avoid duplication when linked (eefba39)
0.15.1 (2021-06-14)
- support passing vite config in vitepress config file via
vite
option (3737b10) - support srcDir config option (aaf4910)
- avoid double resolve user config on startup (5733fc6)
-
Some config options have changed.
vueOptions
renamed tovue
alias
option has been removed. Usevite.resovle.alias
instead.
0.15.0 (2021-06-14)
- more efficient
useData()
method that exposes all data (0661063)
-
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 useuseData()
to retrieve VitePress data in Vue components.
0.14.1 (2021-06-08)
0.14.0 (2021-05-27)
- 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)
- 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)
- search: silence warning for prop (0716ffa)
0.13.1 (2021-04-26)
0.13.0 (2021-04-08)
- build fails without css chunks (#209) (#239) (fa469fd)
- css: reuse css vars (#256) (8d91524)
- docs: global-component link (#271) (a43933c)
- locales: use correct lang (#276) (f505db9)
- navbar: use css var for background-color (#264) (f385bc4)
- badge for language-javascript (#245) (f8b4aa5)
0.12.2 (2021-02-15)
- theme-default: avoid ad image distortion on mobile (4a40e1f)
0.12.1 (2021-02-15)
@
alias for import code snippet being alwaysundefined
(#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)
base
option not working on dev mode (#223) (0b5b306)- frontmatter description duplication (#194) (#170) (338e845)
- sidebar 'auto' not working (#178) (#224) (5deaf6a)
- render document with standards mode in dev (#207) (8a0db65)
- utf-8 character not working on safari in dev mode (#228) (b82d8f2)
- use brand color in algolia search box (2330023)
- If sidebar option is
undefined
it will be treated asauto
, where previsouly it looked like it was treated asfalse
. It was always treated asauto
, but due to this bug, the sidebar was hidden, therefore it looked like it was treated asfalse
.
0.11.5 (2021-01-29)
- avoid layout shift due to ads (#176) (78b026c)
- support symbolic links in building docs dist (#184) (#185) (5190604)
- update base option usage (8cfdd19)
0.11.4 (2021-01-19)
- Latest Vite beta.32 compat (internal changes).
0.11.3 (2021-01-13)
- ignore non-html links in router and prefetch (3e6e61b)
0.11.2 (2021-01-12)
- aria label id (a0f463a)
- generate preload directives for dynamicImport chunks too (b9fc0cb)
0.11.1 (2021-01-12)
- render content on home page (ca631c7)
0.11.0 (2021-01-12)
- move default theme to 'vitepress/theme' (a79e1e1)
- support customData in config (4072dc5)
- 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)
0.10.7 (2021-01-05)
Bump to Vite 2.0.0-beta.8
0.10.6 (2021-01-04)
0.10.5 (2021-01-02)
- vite 2.0.0-beta.2 compat (991a443)
0.10.4 (2021-01-01)
0.10.3 (2021-01-01)
- always define theme globals (8769b4b)
- avoid unexpected vite define replacements in markdown content (a41928e)
- loosen navLink active matching (8a2ff33)
0.10.2 (2020-12-31)
- adjust multi sidebar matching logic (7e4b16e)
0.10.1 (2020-12-30)
- production ready serve (2d77eaf)
- avoid including optional features in build when not used (c878e6d)
0.10.0 (2020-12-30)
- Upgrade to Vite 2.0
- 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)
- theme: the actionLink miss withBase (#168) (#169) (ffaca73)
- align $title with vuepress (#158) (#163) (30740d3)
- fix h2 anchor hover (9bd79e8), closes #174
- fix inline code not inheriting the parent font size (f5a570f)
- fix link prefetch (ade6ddd)
- hydration mismatch when home page having action link (a7686b7)
- make home page look better (#154) (a084cd3)
- prevLinks and nextLinks config type (#165) (1b6981a)
- siteData passed to enhanceApp being siteDataByRoute (#159) (01d2837)
- 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)
- 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)
- add "last updated" feature (40d204b)
0.8.1 (2020-11-20)
- 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)
- 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)
- add ability to configure markdown options (#127) (#128) (463a03a)
- add serve command (#136) (67868bd)
- better build command output (e435eec)
0.7.4 (2020-11-11)
0.7.3 (2020-11-06)
- Fix sidebar page switch layout shifting
- Fix production hydration mismatch
0.7.2 (2020-11-02)
- adapt to vite fix of ssr build asset paths (6b3fbe3)
0.7.1 (2020-10-30)
- 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)
- 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)
- 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)
- add blockquote styling (8c1aada)
- add charset and viewport meta tags (#77) (2e8e1f5)
- add git repo link and edit links (#55) (0ea34cb)
- add prev/next links (#56) (f52b1d5)
- add responsive sidebar support (#75) (39dbd78)
- add table css from vuepress (#88) (8435e36)
- close the sidebar when clicking outside of the sidebar (#78) (e93ee09)
- navlinks in sidebar (#80) (a20bcf3)
- overwrite prev/next link (#61) (1b96f63)
- support config alias (#59) (63a3691)
- top and bottom slots for sidebar and page (#90) (1106013)
- sidebar: use base when creating link (#74) (79bc9fb)
0.5.0 (2020-07-21)
- decode hash before selecting (e782c4c)
- fix navbar withBase (e9ab56b)
- typings field in package.json (#48) (692a490)
- add external link support for nav items (#46) (44e91bb)
- add multi sidebar support (#38) (#49) (050fa4c)
- i18n support (#50) (7802cb5)
- nav dropdown (#51) (5780461)
0.4.1 (2020-07-02)
- avoid error when requesting non-existing md file (e77ea63)
- resolve relative path on windows (#27) (9116c9c)
- use resolve instead of join (#33) (6f10ed6)
0.4.0 (2020-06-19)
0.3.1 (2020-06-05)
- avoid using DEV + throttle active header link (a63b0cf)
0.3.0 (2020-06-02)
- lazy load @vue/server-render for production build (382e1b6)
- active sidebar links (d2ea963)
0.2.0 (2020-05-22)
- copy public dir (ddc9d51)
- lean builds (b61e239)
- prefetch in viewport inbound page chunks (da4852a)
- use hashed page file names (a873564)
- use modulepreload links (0025af1)
- inject script tags for page common chunk imports (57d900d)
- fix dependency versions