GitHub - ravenq/markdown-it-vue: The vue lib for markdown-it. (original) (raw)

markdown-it-vue

The vue lib for markdown-it.

Demo online

http://www.aqcoder.com/markdown

Install

npm install markdown-it-vue

Running Demo

open http://localhost:8080/

Supports

Image size and Viewer
Official markdown syntax.
GFM TOC
GFM style
emoji
mermaid charts
Echarts simple only
Flowcharts.js
Subscript/Superscript
AsciiMath
info | error | warning message tip

Plugin list

markdown-it
markdown-it-emoji
markdown-it-sub
markdown-it-sup
markdown-it-footnote
markdown-it-deflist
markdown-it-abbr
markdown-it-ins
markdown-it-mark
markdown-it-katex
markdown-it-task-lists
markdown-it-highlight
markdown-it-latex
markdown-it-container
markdown-it-github-toc
markdown-it-source-map
markdown-it-link-attributes

internal plugin list:

markdown-it-image
markdown-it-font-awsome
markdown-it-link-attributes
markdown-it-highlight
markdown-it-plugin-echarts
markdown-it-plugin-mermaid
markdown-it-plugin-flowchart

Options

use options property to sepcial the options of markdow-it and markdown-it-plugins.

options: { markdownIt: { linkify: true }, linkAttributes: { attrs: { target: '_blank', rel: 'noopener' } } }

more markdown-it options see https://markdown-it.github.io/markdown-it/.

amd default plugins options:

{ linkAttributes: { attrs: { target: '_blank', rel: 'noopener' } }, katex: { throwOnError: false, errorColor: '#cc0000' }, icons: 'font-awesome', githubToc: { tocFirstLevel: 2, tocLastLevel: 3, tocClassName: 'toc', anchorLinkSymbol: '', anchorLinkSpace: false, anchorClassName: 'anchor', anchorLinkSymbolClassName: 'octicon octicon-link' }, mermaid: { theme: 'default' }, image: { hAlign: 'left', viewer: true } }