Skip to content

Latest commit

 

History

History
70 lines (55 loc) · 1.73 KB

README.md

File metadata and controls

70 lines (55 loc) · 1.73 KB

Vue Remarkable

Build Status codebeat badge GitHub open issues npm version MIT License

Vue component for rendering Markdown with remarkable.

Demo

Vue Remarkable

Installation

yarn add vue-remarkable

npm install --save vue-remarkable

Usage

import vueRemarkable from 'vue-remarkable';

export default {
  components: {
    vueRemarkable
  }
}
<vue-remarkable>
{{`
# Vue is awesome 
# h1 Heading
## h2 Heading
### h3 Heading
#### h4 Heading
##### h5 Heading
###### h6 Heading
`}}
</vue-remarkable>

<!-- or -->

<vue-remarkable :source="`
# Vue is awesome 
# h1 Heading
## h2 Heading
### h3 Heading
#### h4 Heading
##### h5 Heading
###### h6 Heading
`"/>

Props

Property Type Default
source String
container String div
class-name String
options Object {}

License

MIT © katalonne