hub / github.com/miaolz123/vue-markdown

github.com/miaolz123/vue-markdown @main sqlite

repository ↗ · DeepWiki ↗

5 symbols 18 edges 7 files 0 documented · 0%

README

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:

[x] automatic table of contents
[x] table & class customize
[x] *SyntaxHighlighter
[x] definition list
[x] strikethrough
[x] GFM task list
[x] abbreviation
[x] superscript
[x] subscript
[x] footnote
[x] insert
[x] *katex
[x] emoji
[x] 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="https://github.com/miaolz123/vue-markdown/raw/main/path/to/vue.js"></script>
<script src="https://github.com/miaolz123/vue-markdown/raw/main/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`	`

=>

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

wrapping the TOC |
| toc-first-level | Number |

| use

if you want to skip

`from the TOC | | toc-last-level | Number |`'toc-first-level' + 1`| use`5`if you want to skip`

`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

Core symbols most depended-on inside this repo

Shape

Function 5

Languages

TypeScript100%

Modules by API surface

src/VueMarkdown.js4 symbols

src/build.js1 symbols

Dependencies from manifests, versioned

babel-core6.8.0 · 1×

babel-loader6.2.4 · 1×

babel-plugin-transform-es2015-parameters6.8.0 · 1×

babel-plugin-transform-runtime6.8.0 · 1×

babel-preset-es20156.6.0 · 1×

babel-runtime6.6.1 · 1×

cross-env3.0.0 · 1×

css-loader0.23.1 · 1×

file-loader0.9.0 · 1×

highlight.js9.12.0 · 1×

json-loader0.5.7 · 1×

loglevel1.4.1 · 1×

For agents

$ claude mcp add vue-markdown \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

github.com/miaolz123/vue-markdown @main sqlite

vue-markdown

Example

Installation

Browser globals

NPM

Yarn

CommonJS

ES6 (Vue-CLI users)

Slots

Props

from the TOC | | toc-last-level | Number |'toc-first-level' + 1| use5if you want to skip

Events

Thanks

Contributions

License

Core symbols most depended-on inside this repo

Shape

Languages

Modules by API surface

Dependencies from manifests, versioned

For agents

`from the TOC | | toc-last-level | Number |`'toc-first-level' + 1`| use`5`if you want to skip`