A Powerful Markdown Parser for Vue.js

A Powerful Markdown Parser for Vue.js

vue-markdown is a powerful and high performance markdown parser for Vue.js.


npm npm npm

If you want vue-markdown for vue1.X.X, please checkout vue-markdown1.X.X.

A Powerful and Highspeed Markdown Parser for Vue.

Quick start: <vue-markdown>i am a ~~tast~~ **test**.</vue-markdown>

Supported Markdown Syntax:

  • [x] automatic table of contents
  • [x] table & class customize
  • [x] *SyntaxHighlighter
  • [x] definition list
  • [x] strikethrough
  • [x] GFM task list
  • [x] abbreviation
  • [x] superscript
  • [x] subscript
  • [x] footnote
  • [x] insert
  • [x] *katex
  • [x] emoji
  • [x] mark

*SyntaxHighlighter work with Prism recommend

*katex need add katex css.




Live Demo


Browser globals

The dist folder contains vue-markdown.js with the component exported in the window.VueMarkdown object.

  <vue-markdown>i am a ~~tast~~ **test**.</vue-markdown>
<script src="path/to/vue.js"></script>
<script src="path/to/vue-markdown.js"></script>
    var vm = new Vue({
        el: "body"


$ npm install --save vue-markdown


$ yarn add vue-markdown --save


var VueMarkdown = require('vue-markdown');

new Vue({
  components: {
    'vue-markdown': VueMarkdown

ES6 (Vue-CLI users)

After installing via Yarn or NPM, use the following snippet in the script portion of the Vue component which you wish to render the Markdown.

import VueMarkdown from 'vue-markdown'

new Vue({
  components: {


<vue-markdown>this is the default slot</vue-markdown>

After setting up the middleware in your vue component above, using the embedded markdown is as easy as writing it between the vue-markdown tags.

VueMarkdown has a default slot which is used to write the markdown source.

TIP: The default slot only renders once at the beginning, and it will overwrite the prop of source!


Prop Type Default Describe
watches Array ["source", "show", "toc"] HTML refresh automatically when the prop in this array changed
source String null the markdown source code
show Boolean true enable render to the default slot automatically
html Boolean true enable HTML syntax in source
xhtml-out Boolean true <br></br> => <br />
breaks Boolean true \n => <br>
linkify Boolean true autoconvert URL-like text to link
emoji Boolean true :)=>

Github Repository

Tags: #VueJs