vue-markdown

README
Issues 98

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:

*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

Yarn

$ yarn add vue-markdown --save

CommonJS

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

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'

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`	`:)` => `😃`
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'`
prerender	Function (String) String	`null`	filter function before markdown parse
postrender	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`

Thanks

Contributions

License

98 Open More issues

Closed

vue-markdown is not rendering

Hi,

I try to generate markdown but does'nt work:

<template>
    <vue-markdown>i am a ~~tast~~ **test**.</vue-markdown>
</template>

<script>
  import VueMarkdown from 'vue-markdown'

  export default {
    components: {
      VueMarkdown
    }
  }

</script>

output is: i am a ~~tast~~ **test**. in a <div>

bug

opened Oct 25, 2016 by ozee31 12

Closed

Anchor tags options

Purpose of this PR is to add in the ability to define attributes you want on anchor tags. The problem I am trying to solve is

Open links in a new tab (Solved in version 2.1.4)
Also protect against target="_blank" XSS attacks

To use this new attribute, it might look something like this

<template>
    <vue-markdown :anchorAttributes="anchorAttributes">{{ text }}</vue-markdown>
</template>
<script>
export default {
    data: () {
        anchorAttributes: {
            target: '_blank',
            rel: 'noopener noreferrer nofollow'
        }
    }
}
</script>

Please comment with any suggestions or improvements you would like to see.

opened Jul 26, 2017 by printscreen 9

Closed

Hi, how can I use syntaxhighligt?

As title, I install the package, but as you can see, the javascript code can not be highlighted, I would like to know what I didn't add and what I should do!Thanks!

opened Apr 25, 2017 by zhangqiongyu 7

Closed

adds task list support

opened Jul 22, 2017 by LeFnord 5

Closed

How to use external .md file?

I base on Meteor + Vue.

// changelog.md
# Vue markdown
...........
----------
<template>
   <vue-markdown source="./changelog.md"></vue-markdown>
</template>

But don't work, please help me

opened Jan 12, 2018 by thearabbit 4

Closed

Import external markdown

I'm a JS and Vue.js noob so forgive me if this a dumb question.

Is there a way to parse and render markdown text from a .md file stored in my static folder? Maybe using import or webpack?

If yes I think documenting this would be a great addition :-)

help wanted

opened Jan 19, 2017 by guillaumemolter 4

Open

Vue 3 Compatibility

Is this library compatible with Vue 3? If not, are there plans to make a Vue 3 compatible version? Thank you.

opened Oct 3, 2022 by bsansone 0

Open

启动项目时控制台报错

启动项目时控制台报错： babel-runtime/core-js/get-iterator in ./node_modules/vue-markdown/dist/vue-markdown.common.js babel-runtime/core-js/object/keys in ./node_modules/vue-markdown/dist/vue-markdown.common.js

按照提示安装时同样报错

opened Mar 22, 2022 by fade24away 1

Open

vue3 错误提示使用时报错 createElement is not a function

代码

<template>
  <Mgr>
    <vue-markdown :source="mdText"></vue-markdown>
  </Mgr>
</template>

<script>
import Mgr from '@/components/mgr/Mgr'
import VueMarkdown from 'vue-markdown'

export default {
  name: "WebDoc",
  components: {Mgr, VueMarkdown},
  data() {
    return {
      mdText: '# aaa'
    }
  },
}
</script>
<style lang="less" scoped>
</style>

错误内容

vue-markdown.common.js?9ce6:325 Uncaught (in promise) TypeError: createElement is not a function
    at Proxy.render (vue-markdown.common.js?9ce6:325)
    at renderComponentRoot (runtime-core.esm-bundler.js?5c40:893)
    at ReactiveEffect.componentUpdateFn [as fn] (runtime-core.esm-bundler.js?5c40:5030)
    at ReactiveEffect.run (reactivity.esm-bundler.js?a1e9:167)
    at setupRenderEffect (runtime-core.esm-bundler.js?5c40:5156)
    at mountComponent (runtime-core.esm-bundler.js?5c40:4939)
    at processComponent (runtime-core.esm-bundler.js?5c40:4897)
    at patch (runtime-core.esm-bundler.js?5c40:4489)
    at mountChildren (runtime-core.esm-bundler.js?5c40:4685)
    at processFragment (runtime-core.esm-bundler.js?5c40:4856)

推测应该是 highlight.js 库不支持导致的,需要升级应该这个库

opened Mar 1, 2022 by tech-xs 0

Open