vue-markdown-plus

v2.1.1

Published

3 years ago

A Powerful and Highspeed Markdown Parser for Vue

Downloads

1,329

0High
0Medium
0Low

6etacat

vue markdown vue-markdown vue-markdown-plus

vue-markdown-plus

This package only supports vue2.X.X.

A powerful and highspeed Markdown component for Vue.

This is an extension to miaolz123's vue-markdown. The last update to vue-markdow code was in 2017, and is not actively maintained (dependencies contain security vulnerabilities). This package intends to be a safe, up-to-date alternative to vue-markdown.

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

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] custom attributes (class, id, etc.)
[x] superscript
[x] subscript
[x] footnote
[x] insert
[x] *katex
[x] emoji
[x] mark

*SyntaxHighlighter work with Prism

*katex needs katex css.

Example

simple

webpack-simple

Live Demo

Installation

NPM

$ npm install --save vue-markdown-plus

Yarn

$ yarn add vue-markdown-plus --save

Browser globals (NOT RECOMMENDED)

This is not recommended for user inputs, as it will cause XSS vulnerabilities. Please use npm or yarn if possible.

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

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

CommonJS

var VueMarkdownPlus = require("vue-markdown-plus");

new Vue({
  components: {
    "vue-markdown-plus": VueMarkdownPlus,
  },
});

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 VueMarkdownPlus from "vue-markdown-plus";

new Vue({
  components: {
    VueMarkdownPlus,
  },
});

Slots

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

After setting up the middleware in your vue component above, using the embedded markdown is as easy as writing it between the vue-markdown-plus 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 | ---------------------- | watches | Array | source | String | show | Boolean | html | Boolean | xhtml-out | Boolean | breaks | Boolean | linkify | Boolean | emoji | Boolean | typographer | Boolean | lang-prefix | String | quotes | String | table-class | String | task-lists | Boolean | toc | Boolean | toc-id | String | toc-class | String | toc-first-level | Number | toc-last-level | Number | toc-anchor-link | Boolean | toc-anchor-class | String | toc-anchor-link-symbol | String | toc-anchor-link-space | Boolean | toc-anchor-link-class | String | anchorAttributes | Object | prerender | postrender | Default | Describe | | ------------------------ | --------------------------- | ------------------------------------------------------------------------------------------------------ | | ["source", "show", "toc"] | HTML refresh automatically when the prop in this array changed | | null | the markdown source code | | true | enable render to the default slot automatically | | true | enable HTML syntax in source use with caution, do not enable on user inputs to prevent XSS attacks | | true | <br></br> => <br /> | | true | \n => <br> | | true | autoconvert URL-like text to link | | true | :) => 😃 | | true | enable some language-neutral replacement and quotes beautification | | language- | CSS language prefix for fenced blocks | | “”‘’ | use “”‘’ for Chinese, „“‚‘ for German, «»„“ for Russian | | table | customize html class of the <table> | | true | enable GFM task list | | false | enable automatic table of contents | | undefined | the HTML id to render TOC | | table | customize html class of the <ul> wrapping the TOC | | 2 | use 2 if you want to skip <h1> from the TOC | | 'toc-first-level' + 1 | use 5 if you want to skip <h6> from the TOC | | true | enable the automatic anchor link in the headings | | toc-anchor | customize the anchor class name | | # | customize the anchor link symbol | | true | enable inserting a space between the anchor link and heading | | toc-anchor-link | customize the anchor link symbol class name | | {} | anchor tag attributes such as target: '_blank' or rel: 'nofollow' | | Function (String) String | null | filter function before markdown parse | | Function (String) String | null | filter function after markdown parse |

Events

| Name | Param[Type] | Describe | | ------------ | --------------- | --------------------------------------------------------------------------- | | rendered | outHtml[String] | dispatch when render finish | | toc-rendered | tocHtml[String] | dispatch when TOC render finish, never dispatch if the toc[prop] is false |

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

vue-markdown-plus

Example

Installation

NPM

Yarn

Browser globals (NOT RECOMMENDED)

CommonJS

ES6 (Vue-CLI users)

Slots

Props

Events

Thanks

Contributions

License