A markdown & vue preview plugin for vite.
- markdown file
- vue demo preview
- vue demo source
- add tests
- add playground
- sourcemap
- better hmr
- support highlight options
- gray-matter
yarn add vite-plugin-vuedoc
type VueDocPluginOptions = {
wrapperClass: string
previewClass: string
markdownPlugins: any[]
}
- wrapperClass default: ''
classname wrapped markdown file
- previewClass default: ''
classname wrapped vuedemo
- markdownPlugins default: []
markdown-it plugins
// vite.config.ts
import type { UserConfig } from 'vite'
import vitePluginVuedoc from 'vite-plugin-vuedoc'
const config: UserConfig = {
plugins: [vitePluginVuedoc()]
}
export default config
import 'vite-plugin-vuedoc/style.css'
// main.ts
import { createApp } from 'vue'
import App from './App.vue'
import 'vite-plugin-vuedoc/style.css'
const app = createApp(App)
app.mount('#app')
// router.ts
export const router = createRouter({
routes: [
{ path: '/home', redirect: '/' },
{
path: '/button',
name: 'button',
component: async () => import('./docs/Button.zh-CN.md')
}
]
})
vue javascript