Vue Remark

Heavily inspired by React Markdown

Installation

yarn add @willsoto/vue-remark

npm install @willsoto/vue-remark

import VueRemark from "@willsoto/vue-remark";

export default {
  components: {
    VueRemark
  }
};

Example

<template>
  <vue-remark :source="source" />
</template>

import VueRemark from "@willsoto/vue-remark";

export default {
  components: {
    VueRemark
  },
  data() {
    return {
      source: "# Some heading"
    };
  }
};

Options

Name	Type	Required
source	String	true
plugins	Array	false
renderers	Object	false

Node Types

blockquote
break
code
definition (not rendered by default)
delete
emphasis
heading
html
image
imageReference
inlineCode
link
linkReference
list
listItem
paragraph
root
strong
table
tableBody
tableCell
tableHead
tableRow
text
thematicBreak