https://github.com/v-poc/vpressdemo
Support demo import and preview for vitepress.
https://github.com/v-poc/vpressdemo
vitepress-demo-import vitepress-demo-preview vue-demo-preview
Last synced: 2 months ago
JSON representation
Support demo import and preview for vitepress.
- Host: GitHub
- URL: https://github.com/v-poc/vpressdemo
- Owner: v-poc
- License: mit
- Created: 2023-05-21T08:28:42.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-27T05:44:37.000Z (10 months ago)
- Last Synced: 2024-10-11T00:31:03.662Z (8 months ago)
- Topics: vitepress-demo-import, vitepress-demo-preview, vue-demo-preview
- Language: Vue
- Homepage:
- Size: 2.12 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# vpressdemo
[](https://www.npmjs.com/package/vpressdemo)
## INTRODUCTION
> This is a lightweight demo to demonstrate `demo import and preview` based on VitePress.
## Usage
```
npm i -D vpressdemo shiki
```
```js
// .vitepress/config.ts / config.js
import vpressdemo from "../node_modules/vpressdemo/dist";
// ...
export default {
// ...
markdown: {
// ...
config: (md) => {
md.use(vpressdemo);
},
},
};
```
```js
// .vitepress/theme/index.ts / index.js
import DefaultTheme from "vitepress/theme";
import demo from "../../node_modules/vpressdemo/dist/demo.vue";
// ...
export default {
...DefaultTheme,
// ...
enhanceApp({ app }) {
app.component("demo", demo);
},
};
```
```
```
## Project setup
### How to setup your project
```
pnpm i
```
### Compiles and hot-reloads for development
```
pnpm start
```
### Compiles and minifies for production
```
pnpm run build
```
### Customize configuration
About vite, please check Configuration Reference - [vite](https://vitejs.dev/config/).
## License
