• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    公众号

markdown-it-vue: markdown-it-vue 是一个丰富的 markdown Vue 组件,markdown-it-vue ...

原作者: [db:作者] 来自: 网络 收藏 邀请

开源软件名称:

markdown-it-vue

开源软件地址:

https://gitee.com/ravenq/markdown-it-vue

开源软件介绍:

markdown-it-vue

Build Status

Markdown Vue 组件库.

markdown-it-vue 是一个丰富的 markdown Vue 组件,markdown-it-vue 使用 markdown-it 作为 Markdown 数据解析引擎,整合多种 markdown-it 插件,并内置了一些自己的功能性插件,支持 GFM TOC、GFM style、emoji 等通用特性,还支持 mermaid charts、Echarts、flowchart.js 等多种图表,支持 AsciiMath、Latex 等数学公式渲染,支持 errro | warning | info 个性化提示。

在线示例

http://www.aqcoder.com/markdown

由于众所周知的原因,可能需要 fan qiang。

安装

npm install markdown-it-vue

特性

  • 图片大小控制及图片预览
  • Official markdown syntax.
  • GFM TOC
  • GFM style
  • emoji
  • mermaid charts
  • Echarts
  • Flowcharts.js
  • Subscript/Superscript
  • AsciiMath
  • info | error | warning message tip

使用的插件

  • 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-icons
  • markdown-it-highlight
  • markdown-it-latex
  • markdown-it-container
  • markdown-it-github-toc
  • markdown-it-source-map
  • markdown-it-link-attributes

内置插件:

  • 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

markdown-it 及个插件选项

使用 options 指定 markdow-it 和个插件的选项。

<markdown-it-vue class="md-body" :content="content" :options="options" />
options: {  markdownIt: {    linkify: true  },  linkAttributes: {    attrs: {      target: '_blank',      rel: 'noopener'    }  }}

更多 markdown-it 选项见官方文档:https://markdown-it.github.io/markdown-it/

插件默认选项如下:

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

个插件详细说明见个插件官方文档。

自定义插件

it can add your plugin to markdown-it-vue by the use method.

this.$refs.myMarkdownItVue.use(MyMarkdownItPlugin)

支持高亮的语言

语言高亮使用 hilight.js 打包过大,因此只引用了常用的语言。

如果这里没有你需要的语言,欢迎提 PR。

  • html
  • json
  • css
  • shell
  • bash
  • C
  • Java
  • Python
  • C++
  • C#
  • PHP
  • SQL
  • R
  • Swift
  • Go
  • MATLAB
  • Ruby
  • Perl
  • Objective-C
  • Rust
  • Dart
  • Delphi
  • D
  • Kotlin
  • Scala
  • SAS
  • Lisp
  • Lua
  • Ada
  • Fortran
  • PowerShell
  • VBScript
  • VBscript-html
  • Groovy
  • Julia
  • Julia-repl
  • LabVIEW
  • Haskell
  • ActionScript
  • Scheme
  • TypeScript
  • F#
  • Prolog
  • Erlang

图片大小控制语法

![image size](https://http://www.aqcoder.com/ravenq-qr.png =50x50)![image size](https://http://www.aqcoder.com/ravenq-qr.png =x50)![image size](https://http://www.aqcoder.com/ravenq-qr.png =50x)

关于 echarts

为了减少包的大小,只引用 echarts.simple。

精简版 markdown-it-vue-light

https://github.com/ravenq/markdown-it-vue/issues/24

为了进一步缩小打包的大小,移除了 mermaid chart。这包直接引用了整个 lodash, 他本身也很大。

如果平时用不到的话,就用精简版吧。

使用示例

<template>  <div>    <markdown-it-vue class="md-body" :content="content" />  </div></template><script>import MarkdownItVue from 'markdown-it-vue'import 'markdown-it-vue/dist/markdown-it-vue.css'export default {  components: {    MarkdownItVue  },  data() {    return {      content: '# your markdown content'    }  }}</script>

使用精简版

<template>  <div>    <markdown-it-vue-light class="md-body" :content="content" />  </div></template><script>import MarkdownItVueLight from 'markdown-it-vue/dist/markdown-it-vue-light.umd.min.js'import 'markdown-it-vue/dist/markdown-it-vue-light.css'export default {  components: {    MarkdownItVueLight  },  data() {    return {      content: '# your markdown content'    }  }}</script>

示例截图

markdown-it-vue

License

MIT


鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
热门推荐
热门话题
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap