Vite & Vue powered static site generator.
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.
 
 
 
 
Go to file
Kia King Ishii a491fe20e4
chore: add notice about `build` step in contribution guide
3 years ago
.github chore: add notice about `build` step in contribution guide 3 years ago
__tests__ style: format 3 years ago
bin feat: migrate to ESM (#645) (#659) 3 years ago
docs docs: make readme alpha ready 3 years ago
examples/minimal chore: update minimal example to look better 3 years ago
scripts feat: migrate to ESM (#645) (#659) 3 years ago
src style: format 3 years ago
types feat: add collapsible option to sidebar (#640) (#663) 3 years ago
.gitignore chore: ignore pnpm global link dir 3 years ago
.prettierignore style: format code 3 years ago
.prettierrc init 5 years ago
CHANGELOG.md release: v0.22.4 3 years ago
LICENSE chore: readme and license 5 years ago
README.md docs: make readme alpha ready 3 years ago
client.d.ts feat: new default theme 3 years ago
netlify.toml workflow: switch to pnpm (#401) 3 years ago
package.json style: format code 3 years ago
pnpm-lock.yaml feat: migrate to ESM (#645) (#659) 3 years ago
pnpm-workspace.yaml workflow: switch to pnpm (#401) 3 years ago
rollup.config.ts style: format 3 years ago
theme.d.ts fix(types): fix vitepress/theme type 3 years ago
tsconfig.json style: format code 3 years ago

README.md

VitePress (alpha) 📝💨

Test npm


VitePress is VuePress' spiritual successor, built on top of vite.

Currently, it's in the alpha stage. It is already suitable for out-of-the-box documentation use, but the config and theming API may still change between minor releases.

Documentation

To check out docs, visit vitepress.vuejs.org.

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

Copyright (c) 2019-present, Yuxi (Evan) You