{"id":27519,"library":"vite-plugin-md","title":"vite-plugin-md","description":"Vite plugin for using Markdown files as Vue components. Current stable version is 0.21.5 (latest 0.22.5 has breaking issues with builder API; users of builder APIs should use 0.22.1 or 0.21.5). Released monthly. Key differentiators: supports Vue components in Markdown and Markdown as Vue components; provides a pipeline/builder system for custom transformations; extracted builders (code, meta, link) are external packages. Alternative: vite-plugin-vue-markdown for simpler transformation.","status":"active","version":"0.21.5","language":"javascript","source_language":"en","source_url":"https://github.com/antfu/vite-plugin-md","tags":["javascript","vite","vite-plugin","markdown-it","typescript"],"install":[{"cmd":"npm install vite-plugin-md","lang":"bash","label":"npm"},{"cmd":"yarn add vite-plugin-md","lang":"bash","label":"yarn"},{"cmd":"pnpm add vite-plugin-md","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"peer dependency: requires Vite 4+ for compatibility","package":"vite","optional":false},{"reason":"peer dependency: required to process Vue SFCs from Markdown","package":"@vitejs/plugin-vue","optional":false}],"imports":[{"note":"Default import; ESM only since v0.22. CommonJS require will fail.","wrong":"const Markdown = require('vite-plugin-md')","symbol":"Markdown","correct":"import Markdown from 'vite-plugin-md'"},{"note":"Named import is incorrect; use default import. TypeScript types are exported alongside.","wrong":"import { Markdown } from 'vite-plugin-md'","symbol":"Markdown","correct":"import Markdown from 'vite-plugin-md'"},{"note":"Type-only import for TypeScript; use 'import type' syntax to avoid runtime inclusion.","wrong":null,"symbol":"BuilderApi type","correct":"import type { BuilderApi } from 'vite-plugin-md'"},{"note":"Builders were externalized; do not import from vite-plugin-md. Use '@yankeeinlondon/code-builder' or 'md-powerpack'.","wrong":"import { code } from 'vite-plugin-md'","symbol":"code builder","correct":"import code from '@yankeeinlondon/code-builder'"}],"quickstart":{"code":"// vite.config.ts\nimport { defineConfig } from 'vite'\nimport Vue from '@vitejs/plugin-vue'\nimport Markdown from 'vite-plugin-md'\n\nexport default defineConfig({\n  plugins: [\n    Vue({\n      include: [/\\.vue$/, /\\.md$/],\n    }),\n    Markdown(),\n  ],\n})","lang":"typescript","description":"Shows basic Vite config with Vue and Markdown plugin; registers .md files as Vue components."},"warnings":[{"fix":"Downgrade to v0.22.1: npm install vite-plugin-md@0.22.1","message":"v0.22.2, v0.22.3, v0.22.4 have serious issues with the Builder API; users are advised to revert to v0.22.1 or v0.21.5.","severity":"breaking","affected_versions":">=0.22.2 <0.22.5"},{"fix":"Add 'auto-install-peers=true' to .npmrc, or manually install peer deps: npm install vite @vitejs/plugin-vue","message":"Peer dependencies (vite, @vitejs/plugin-vue) are not automatically installed; you must install them manually or configure npm to auto-install.","severity":"gotcha","affected_versions":">=0.21.0"},{"fix":"Use import syntax (ESM) in your project; ensure package.json has 'type': 'module'.","message":"ESM-only since v0.22; CommonJS require will throw an error.","severity":"breaking","affected_versions":">=0.22.0"},{"fix":"If you need the old behavior, use 'vite-plugin-vue-markdown'. For new projects, use vite-plugin-md with builders.","message":"v0.13 introduced pipeline/builder engine; the old 'simple' Markdown-to-Vue transformation was moved to vite-plugin-vue-markdown. Using vite-plugin-md with old config may break.","severity":"deprecated","affected_versions":"<0.13"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Run 'npm install vite-plugin-md -D'","cause":"Package not installed or incorrect import path.","error":"Error: Cannot find module 'vite-plugin-md'"},{"fix":"Run 'npm install @vitejs/plugin-vue -D'","cause":"Missing peer dependency.","error":"Cannot find module '@vitejs/plugin-vue'"},{"fix":"Run 'npm install -D @yankeeinlondon/code-builder' and import 'code' from that package.","cause":"Importing 'code' builder incorrectly from 'vite-plugin-md' instead of '@yankeeinlondon/code-builder'.","error":"Cannot read properties of undefined (reading 'code')"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}