mirror of https://github.com/vuejs/vitepress
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.
29 lines
1.0 KiB
29 lines
1.0 KiB
# VitePress (alpha) 📝💨
|
|
|
|
[](https://github.com/vuejs/vitepress/actions)
|
|
[](https://www.npmjs.com/package/vitepress)
|
|
|
|
---
|
|
|
|
VitePress is [VuePress](https://vuepress.vuejs.org)' spiritual successor, built on top of [vite](https://github.com/vitejs/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](https://vitepress.vuejs.org).
|
|
|
|
## Changelog
|
|
|
|
Detailed changes for each release are documented in the [CHANGELOG](https://github.com/vuejs/vitepress/blob/main/CHANGELOG.md).
|
|
|
|
## Contribution
|
|
|
|
Please make sure to read the [Contributing Guide](https://github.com/vuejs/vitepress/blob/main/.github/contributing.md) before making a pull request.
|
|
|
|
## License
|
|
|
|
[MIT](https://github.com/vuejs/vitepress/blob/main/LICENSE)
|
|
|
|
Copyright (c) 2019-present, Yuxi (Evan) You
|