@ver5/vitepress-ui
v1.0.0
Published
A collection of Vue components for VitePress uses.
Downloads
3
Maintainers
Readme
@ver5/vitepress-ui
A collection of Vue components Nolebase uses.
[!CAUTION]
This package is in Alpha stage.
This package is still in the Alpha stage, and it is not recommended to use it in production. The API may change in the future, and there may be bugs in the current version. Please use it with caution.
[!IMPORTANT]
Before install
Currently
@ver5/vitepress-ui
is still under development, and will be used by other Nolebase Integrations components now. There are a few configurations that needed to be configured if you would ever want to install@ver5/vitepress-ui
as one of your dependencies:1. Additional configurations for Vite
1.1 For users who imported
<NuLazyTeleportRiveCanvas />
componentSince
<NuLazyTeleportRiveCanvas />
depends on@rive-app/canvas
. If you also use Vite as your bundler, you will need to add the following configurations to yourvite.config.ts
file like this:export default defineConfig(() => { return { optimizeDeps: { include: [ // Add this line to your vite.config.ts '@ver5/vitepress-ui-rive-canvas > @rive-app/canvas', ], }, } })
For more information about why configure this, please refer to the Dep Optimization Options | Vite documentation.
1.2 For users who imported VitePress related components
If you are using VitePress, you will need to add the following configurations to your
vite.config.ts
file like this:export default defineConfig(() => { return { ssr: { noExternal: [ // Add this line to your vite.config.ts '@ver5/vitepress-ui', ], }, } })
For more information about why configure this, please refer to the Server-Side Rendering | Vite documentation.
Install
Npm
npm i @ver5/vitepress-ui -D
Yarn
yarn add @ver5/vitepress-ui -D
Pnpm
pnpm add @ver5/vitepress-ui -D
Documentation
Please refer to UI Components for more information.