vue-markdown-konishi v0.2.10
This fork is intended to work with Webpack 4 and Babel 7, it's open for issues and help is welcome, for now:
Added :
- markdown-it-container
- markdown-it-source-map
- Corrected the source for mardown-it-katex
- update dependencies to work with Babel V7
- created a dist folder using Webpack 4 and Babel 7
vue-markdown
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:
- Source map in html (data-source-line="")
- *SyntaxHighlighter
- custom container
- definition list
- strikethrough
- GFM task list
- superscript
- subscript
- *katex
- emoji
- mark
*SyntaxHighlighter work with Prism recommend
*katex need add katex css.
Example
Installation
Browser globals
The dist folder contains
vue-markdown.jswith the component exported in thewindow.VueMarkdownobject.
<body>
<vue-markdown>i am a ~~tast~~ **test**.</vue-markdown>
</body>
<script src="path/to/vue.js"></script>
<script src="path/to/vue-markdown.js"></script>
<script>
Vue.use(VueMarkdown);
var vm = new Vue({
el: "body"
});
</script>NPM
$ npm install --save vue-markdown-konishior Yarn
$ yarn add vue-markdown-konishi --saveCommonJS
var VueMarkdown = require('vue-markdown-konishi');
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-konishi'
new Vue({
components: {
VueMarkdown
}
})Slots
<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!
Props
| Prop | Type | Default | Describe |
|---|---|---|---|
| watches | Array | ["source", "show"] | 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 | :) => 😃 |
| sourceMap | Boolean | true | add line number in html data attribute |
| typographer | Boolean | true | enable some language-neutral replacement and quotes beautification |
| lang-prefix | String | language- | CSS language prefix for fenced blocks |
| quotes | String | “”‘’ | use “”‘’ for Chinese, „“‚‘ for German, «»„“ for Russian |
| table-class | String | table | customize html class of the <table> |
| task-lists | Boolean | true | enable GFM task list |
| prerender | Function (String) String | null | filter function before markdown parse |
| postrender | Function (String) String | null | filter function after markdown parse |
Events
| Name | ParamType | Describe |
|---|---|---|
| rendered | outHtmlString | dispatch when render finish |
| toc-rendered | tocHtmlString | dispatch when TOC render finish, never dispatch if the tocprop is false |
Container
Example:
::: danger
*here be dragons*
:::Will give:
<div class="danger" data-source-line="31">
<p><em>here be dragons</em></p>
</div>Possible containers:
- warning
- info
- danger
- success
- to-left
- to-right
- centered
- justify