0.0.1-alpha.3 • Published 12 months ago
vite-plugin-vitepress-liu v0.0.1-alpha.3
vite-plugin-vitepress
A use vitePress theme plugin for Vite.
Install
npm i -D vite-plugin-vitepress
Usage
In vite.config.[t|j]s
:
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import VitePluginVitepress from '../src'
export default defineConfig({
plugins: [
VitePluginVitepress(),
vue({
include: [/\.vue$/, /\.md$/],
}),
],
})
You need to import the vitepress
theme in your main.[t|j]s
file.
import "vite-plugin-vitepress/theme"
Options
- markdown:
MarkdownOptions
instance, similar to vitepress config markdown
TypeScript Config
If you're using Typescript than you'll want take the additional step of adding a "shim file" to help Typescript to understand how to think of Vue SFC files and Markdown files structurally. For VueJS developers, you've probably already done this for your VueJS files but you can wrap this up with a single file -- shims.d.ts -- in the root of your repo:
declare module '*.vue' {
import type { ComponentOptions } from 'vue'
const Component: ComponentOptions
export default Component
}
declare module '*.md' {
import type { ComponentOptions } from 'vue'
const Component: ComponentOptions
export default Component
}
Example Usage
See the example app in this repo.
0.0.1-alpha.3
12 months ago