@vitepress-demo-preview/component
v2.3.2
Published
preview component of code and component in vitepress
Downloads
4,878
Readme
🎉 Introduce
We can see their component display and code example display from some excellent UI component libraries such as element-plus
and Ant Design Vue
This project is based on vitepress
and markdown-it
implementation to display components and code examples in documents. Using this plug-in, Vue SFC components can be displayed in static documents
🏄♂️ Packages
| Package | Version (click for changelogs) | | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | @vitepress-demo-preview/component | | | @vitepress-demo-preview/plugin | |
⚙️ Installation
pnpm add @vitepress-demo-preview/component @vitepress-demo-preview/plugin
⚡ Usage
configure in your vitepress/theme entry file
import { AntDesignContainer, ElementPlusContainer, NaiveUIContainer } from '@vitepress-demo-preview/component'
import '@vitepress-demo-preview/component/dist/style.css'
export default {
...DefaultTheme,
enhanceApp({ app }: { app: App }) {
app.component('demo-preview', AntDesignContainer)
}
}
configure markdown to add plugin
import { defineConfig } from 'vitepress'
import { containerPreview, componentPreview } from '@vitepress-demo-preview/plugin'
export default defineConfig({
markdown: {
config(md) {
md.use(containerPreview)
md.use(componentPreview)
}
}v
})
Preview of Component Form
<!-- Tip: Support for closed tags -->
<preview path="./xxx/xx.vue"></preview>
<preview path="./xxx/xx.vue" title="title"></preview>
<preview path="./xxx/xx.vue" title="title" description="component description content"></preview>
Preview by Container Form
:::preview
demo-preview=./xxx/xx.vue
:::
:::preview title
demo-preview=./xxx/xx.vue
:::
:::preview title || component description content
demo-preview=./xxx/xx.vue
:::
📦 Packages
@vitepress-demo-preview/plugin
@vitepress-demo-preview/plugin
is a markdown-it plugin, which mainly provides two kinds of Component preview methods, namely Component Form and Container Form.
@vitepress-demo-preview/component
@vitepress-demo-preview/component
is a component library that provides presentation components. It mainly provides three containers. These are Ant Design Container, ElementPlus Container, and Naive UI Container, which mimic the styles associated with the preview of each UI framework component.
Of course, we will also consider providing similar component containers for other component libraries.
Tip: @vitepress-demo-preview/component
is not necessary. You can also consider just using the @vitepress-demo-preview/plugin
, which is not bound to each other. You can implement your own component container according to your own preferences and needs. For details, refer to the source code of the above three containers.
📑 License
Copyright (c) 2023 flingyp