VueMarkik

Markdown rendering for Vue.js - extensible and customizable, powered by unified, remark, and rehype

Features

✨ Safe Rendering - No dangerouslySetInnerHTML, all content is rendered through Vue components
🎨 Custom Components - Replace any markdown element with your own Vue components
🔌 Plugin Support - Full support for remark and rehype plugins
📝 GFM & More - GitHub Flavored Markdown, math (KaTeX), diagrams (Mermaid), and syntax highlighting
⚡ Async Support - Built-in async component for loading plugins on demand
🎯 TypeScript - Fully typed with comprehensive type definitions

Quick Start

Installation

npm install vuemarkik
# or
pnpm add vuemarkik
# or
yarn add vuemarkik

Basic Usage

<script setup>
import { Markdown } from 'vuemarkik';
</script>

<template>
  <Markdown text="# Hello World" />
</template>

Documentation

📚 Full Documentation

Getting Started

• Installation & Basic Usage - Get up and running with VueMarkik

Features & Examples

• Syntax Highlighting - Code block highlighting with Shiki
• GitHub Flavored Markdown - Tables, task lists, and more
• KaTeX Math - Render mathematical equations
• Mermaid Diagrams - Create diagrams and flowcharts

Advanced Usage

• Custom Vue Components - Replace markdown elements with your components
• Remark & Rehype Plugins - Extend markdown processing
• API Reference - Complete API documentation

Development

For contribution guidelines, please see CONTRIBUTING.md

Install dependencies

pnpm install

Run the playground

pnpm playground

Run tests

pnpm test

Build the library

pnpm build

License

MIT © 2025-present Tom Auger