1.0.0 • Published 3 years ago

@willsoto/vue-remark v1.0.0

Weekly downloads
8
License
Apache-2.0
Repository
-
Last release
3 years ago

Vue Remark

pipeline status coverage report

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

NameTypeRequired
sourceStringtrue
pluginsArrayfalse
renderersObjectfalse

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