Skip to content

Markdown 富文本

注意

因基于 WebView 渲染,页面中不宜放置大量 Markdown 组件,会引起性能问题

基础用法

  • 基于 markdown-it 实现 Markdown 富文本渲染
  • 支持暗黑模式,内置 highlight.js、上下标、Emoji、 自定义容器等插件,以及类 VitePress 的样式,帮助您更轻松地插入 Markdown 文本
  • 支持双向同步渲染
vue
<template>
	<sn-markdown content="# Hello World\n\nThis is a markdown content."></sn-markdown>
</template>

属性

参数说明类型默认值可选值
width组件宽度String100%-
height组件高度String100%-
contentMarkdown 文本内容String--
theme主题风格Stringlightlight | dark
linkify是否识别并显示链接Booleanfalsetrue | false
typographer启用一些语言中立的替换 + 引号美化Booleanfalsetrue | false
html是否在源码中启用 HTML 标签Booleanfalsetrue | false
xhtmlOut使用 '/' 来闭合单标签 (比如 <br />)Booleanfalsetrue | false
breaks转换段落里的 '\n' 为 <br>。Booleanfalsetrue | false
quotes引用符号,默认为中文引号String'“”‘’'-
langPrefix给围栏代码块的 CSS 语言前缀。对于额外的高亮代码非常有用。String'language-'-
sup是否启用上标扩展功能。详见 markdown-it-supBooleantruetrue | false
sub是否启用下标扩展功能。详见 markdown-it-subBooleantruetrue | false
container是否启用容器扩展功能,如代码块、列表等。详见 自定义容器。Booleantruetrue | false
emoji是否启用 Emoji 扩展功能。详见 markdown-it-emojiBooleantruetrue | false
customStyle自定义容器样式UTSJSONObject{}-

使用 MIT 协议