Vue-markdown-v1 NPM

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
markdown-it-icons
Corrected the source for mardown-it-katex
update dependencies to work with Babel V7
created a dist folder using Webpack 4 and Babel 7

TODO:

It need loader for emoji (markdown-it-emoji)

Next plugin to add:

markdown-it-plugin-echarts
markdown-it-plugin-mermaid
markdown-it-plugin-flowchart

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="")
automatic table of contents
table & class customize
*SyntaxHighlighter
custom container
definition list
strikethrough
GFM task list
abbreviation
superscript
subscript
footnote
insert
*katex
emoji
icon
mark

*SyntaxHighlighter work with Prism recommend

*katex need add katex css.

Example

simple

webpack-simple

Live Demo

Installation

Browser globals

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

<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-v2

or Yarn

$ yarn add vue-markdown-v2 --save

CommonJS

var VueMarkdown = require('vue-markdown-v2);

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-v2'

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", "toc"]`	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`	`:)` => `😃`
markdownItIcons	Boolean	`true`	add Font Awesome icon
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
toc	Boolean	`false`	enable automatic table of contents
toc-id	String	`undefined`	the HTML id to render TOC
toc-class	String	`table`	customize html class of the `<ul>` wrapping the TOC
toc-first-level	Number	`2`	use `2` if you want to skip `<h1>` from the TOC
toc-last-level	Number	`'toc-first-level' + 1`	use `5` if you want to skip `<h6>` from the TOC
toc-anchor-link	Boolean	`true`	enable the automatic anchor link in the headings
toc-anchor-class	String	`toc-anchor`	customize the anchor class name
toc-anchor-link-symbol	String	`#`	customize the anchor link symbol
toc-anchor-link-space	Boolean	`true`	enable inserting a space between the anchor link and heading
toc-anchor-link-class	String	`toc-anchor-link`	customize the anchor link symbol class name
anchorAttributes	Object	`{}`	anchor tag attributes such as `target: '_blank'` or `rel: 'nofollow'`
tag	String	`div`	Output wrap tag, example `<div>...markdown content...</div>` or `<article>...markdown content...</article>`
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

Icons

A :fa-car: runs

A :fa-car: runs

Thanks

Contributions

License

vue markdown vue-markdown

highlight.js markdown-it markdown-it-abbr markdown-it-container markdown-it-deflist markdown-it-emoji markdown-it-icons markdown-it-source-map markdown-it-footnote markdown-it-ins @iktakahiro/markdown-it-katex markdown-it-mark markdown-it-sub markdown-it-sup markdown-it-task-lists markdown-it-toc-and-anchor

@everything-registry/sub-chunk-3085

0.1.0

5 months ago

0.1.7

5 months ago