Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flingyp/vitepress-demo-preview
⚙️⚙️⚙️ Vue component demo preview and source code show of vitepress
https://github.com/flingyp/vitepress-demo-preview
demo plugin preview preview-componnet preview-plugin vitepress vue
Last synced: 3 days ago
JSON representation
⚙️⚙️⚙️ Vue component demo preview and source code show of vitepress
- Host: GitHub
- URL: https://github.com/flingyp/vitepress-demo-preview
- Owner: flingyp
- License: mit
- Created: 2022-08-21T14:53:20.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T07:24:38.000Z (about 2 months ago)
- Last Synced: 2024-10-25T03:18:48.167Z (about 2 months ago)
- Topics: demo, plugin, preview, preview-componnet, preview-plugin, vitepress, vue
- Language: TypeScript
- Homepage: https://flingyp.github.io/vitepress-demo-preview
- Size: 73.9 MB
- Stars: 107
- Watchers: 2
- Forks: 14
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-vitepress-v1 - Preview Demo - Preview demo and show source codes (:electric_plug: Plugins / Community Plugins)
README
vitepress-demo-preview
Demo of Vue SFC components in vitepress
## 🎉 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](packages/component) | [](packages/component/CHANGELOG.md) |
| [@vitepress-demo-preview/plugin](packages/plugin) | [](packages/plugin/CHANGELOG.md) |
## ⚙️ Installation
```sh
pnpm add @vitepress-demo-preview/component @vitepress-demo-preview/plugin
```
## ⚡ Usage
configure in your vitepress/theme entry file
```ts
import DefaultTheme from 'vitepress/theme'
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
```ts
import { defineConfig } from 'vitepress'
import { containerPreview, componentPreview } from '@vitepress-demo-preview/plugin'
export default defineConfig({
markdown: {
config(md) {
md.use(containerPreview)
md.use(componentPreview)
}
}
})
```
### Preview of Component Form
```md
```
### Preview by Container Form
```md
:::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
[MIT](https://github.com/flingyp/vitepress-demo-preview/blob/main/LICENSE)
Copyright (c) 2023 flingyp