Vite & Vue powered static site generator.

Go to file

Divyansh Singh ce395bd181 test(e2e/router): exercise both router strategies Add a parameterised e2e suite that runs the same 22 scenarios against both router implementations (Navigation API and legacy History API). The legacy strategy is forced on via `window.__VP_USE_LEGACY_ROUTER__`, set via Playwright `addInitScript` on a second browser context — the shared browser and default `page` / `goto` from vitestSetup.ts are reused for the Navigation API run, so we don't relaunch Playwright. Scenarios covered, for each mode: - strategy selection reflects the flag - link click performs SPA navigation (no full reload) - hash anchor updates URL, scrolls into view, focuses target heading - back / forward navigate between entries - scroll position restored on back traversal - onBeforeRouteChange / onAfterRouteChange fire for full and hash navs - onBeforeRouteChange returning false cancels the nav - programmatic router.go - router.go with { replace: true } - same-URL click scrolls without pushing a new history entry - onBeforePageLoad / onAfterPageLoad fire - onBeforePageLoad returning false cancels page load - links inside .vp-raw trigger a full reload - external / download / target / non-HTML links are not intercepted - clicks on buttons inside links are not intercepted - route.path / route.hash / route.query stay in sync - unknown paths fall back to the 404 page - route.data.relativePath is populated from the loaded page A small init-script-installed `resolveRouterOrThrow()` finds the router via the Vue app's provides, so `page.evaluate` call sites stay terse and typed against the public `Router` interface — no `any` in test code. To support the flag, `hasNavigationApi()` now honours `window.__VP_USE_LEGACY_ROUTER__` as a forced opt-out; this is documented in-source as a test-only hook.		1 month ago
.github	ci: bump actions and node versions	7 months ago
__tests__	test(e2e/router): exercise both router strategies	1 month ago
art	chore: use SVG logo on main website page (#4623 )	1 year ago
bin	perf: call `module.enableCompileCache()`	1 year ago
docs	chore: bump deps	1 month ago
patches	chore: revert icons plugin bump	2 months ago
scripts	chore: maintenance and cleanup	1 year ago
src	test(e2e/router): exercise both router strategies	1 month ago
template	feat(theme): upgrade DocSearch to 4.5 with sidepanel (#5092 )	4 months ago
types	feat!: support scroll-margin / scroll-padding	1 month ago
.gitattributes	feat: add `transformHead` hook (#1323 )	4 years ago
.gitignore	feat!: support scroll-margin / scroll-padding	1 month ago
.prettierignore	feat(build): support nested markdown includes (#2545 )	3 years ago
.prettierrc.yml	chore: update deps (#1410 )	4 years ago
CHANGELOG.md	chore: bump deps	2 months ago
LICENSE	…
README.md	docs: add special thanks section	3 months ago
client.d.ts	feat(client): emit `vitepress:codeGroupTabActivate` custom event when a code group tab is activated	7 months ago
netlify.toml	ci: bump actions and node versions	7 months ago
package.json	chore: bump deps	1 month ago
pnpm-lock.yaml	chore: bump deps	1 month ago
pnpm-workspace.yaml	chore: revert icons plugin bump	2 months ago
rollup.config.ts	fix(types): externalize markdown-it types	10 months ago
theme-without-fonts.d.ts	chore(build)!: drop cjs api (#2737 )	3 years ago
theme.d.ts	perf: hoist expensive operations in useLayout	1 year ago
tsconfig.json	chore: bump deps, fix dts generation (#3856 )	2 years ago

README.md

VitePress 📝💨

VitePress is a Vue-powered static site generator and a spiritual successor to VuePress, built on top of Vite.

Documentation

To check out docs, visit vitepress.dev.

Changelog

Detailed changes for each release are documented in the CHANGELOG.

Contribution

Please make sure to read the Contributing Guide before making a pull request.

License

MIT

Special Thanks

This project would not be possible without the support of these amazing companies and tools.


	VoidZero	The company behind Vite, Vitest, Rolldown, and Oxc. VoidZero has been a long-time sponsor of VitePress. VitePress itself is built on top of this ecosystem of high-performance JavaScript tooling.
	StackBlitz	Creators of WebContainers and a browser-based development platform. Their technology powers the VitePress playground and provides instant preview releases for our pull requests and commits.
	Algolia	An AI-powered search platform that provides fast, scalable search. Algolia powers DocSearch for VitePress. Their team has been a long-time partner in building and maintaining our search integration.
	BrowserStack	A cloud-based testing platform for websites and mobile apps. BrowserStack provides the cross-browser and real-device infrastructure used to ensure VitePress works consistently across all browsers.