@adapttive/vue-markdown

中文文档

4.0.2发布于 2022/08/28MITTypeScriptCommonJS近 30 天下载 8209

A Powerful and High speed Markdown Parser for Vue

文档目录6 节

Browser globals
NPM
Yarn
Migrating from vue-markdown 2.3
CommonJS
ES6 (Vue-CLI users)

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:

automatic table of contents
table & class customize
*SyntaxHighlighter
definition list
strikethrough
GFM task list
abbreviation
superscript
subscript
footnote
insert
emoji
mark
*katex

*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 @adapttive/vue-markdown

Yarn

$ yarn add @adapttive/vue-markdown --save

Migrating from vue-markdown 2.3

You just need to replace the dependencies in package.json:

{
  "dependencies": {
-  "vue-markdown": "^2.2.4
+  "vue-markdown": "npm:@adapttive/vue-markdown@^X.X.X"
  }
}

CommonJS

var VueMarkdown = require('@adapttive/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 '@adapttive/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
update-prism	Boolean	`true`	if true, vue-markdown will automatically call a re-render of all code blocks through Prism.js (Using Prism.js)
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`	Makes GFM task lists mutable, `false` shows GFM as readonly checkboxes
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
toc-anchor-link-before	Boolean	`true`	allows you to prepend/append the anchor link in the headings
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
inline	Boolean	`false`	result will NOT be wrapped into `<p>` tags

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`

Using Prism.js

Visit the download page
Select all the options that apply for your project
At the bottom of the page download both the JS and CSS
Include them in your index.html MAKE SURE to include Prism before your app.js

Plugins

 <template>
   <div>
     <vue3-markdown-it :source='source' :plugins='plugins' />
   </div>
 </template>

 <script>
 import katex from 'markdown-it-katex';
 import tasklists from 'markdown-it-task-lists';
 import externalPreview from 'markdown-it-external-preview';
 import VueMarkdown from 'vue-markdown';

 export default {
   components: {
     VueMarkdown
   },
   data() {
     return {
       plugins: [
         {
           plugin: katex,
           options: { throwOnError: false, errorColor: ' #cc0000' }
         },
         {
           plugin: tasklists,
           options: { enabled: this.taskLists }
         },
         {
           plugin: externalPreview
         }
       ]
     }
   }
 }
 </script>

Make sure you add dependencies for plugins:
- "highlight.js": "^10.4.0"
- "markdown-it-external-preview": "^1.0.4"
- "markdown-it-katex": "npm:@iktakahiro/markdown-it-katex@^4.0.1"

Thanks

Contributions

License

miaolz123 by MIT
milindsingh by MIT

版本与发布记录

@adapttive/vue-markdown 共发布 20 个版本，首次发布于 2020/12/19；过去 12 个月发布了 0 个版本。

版本	发布日期	距今
`4.0.2`latest	2022/08/28	4 年前
`4.0.1`	2021/03/07	5 年前
`4.0.0`alpha	2021/02/16	5 年前
`3.0.3`	2020/12/26	5 年前
`3.0.2`	2020/12/26	5 年前
`3.0.1`	2020/12/26	5 年前

其他发布通道：beta → 3.0.0-beta.2，alpha → 4.0.0。

关于 @adapttive/vue-markdown 的常见问题

@adapttive/vue-markdown 是什么？

A Powerful and High speed Markdown Parser for Vue

如何安装 @adapttive/vue-markdown？

在项目目录运行 npm install @adapttive/vue-markdown，或使用 pnpm add / yarn add / bun add。

@adapttive/vue-markdown 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

@adapttive/vue-markdown 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require()；在 ES Module 项目中也可以用 import 引入（Node.js 会把 module.exports 作为默认导出）。

@adapttive/vue-markdown 可以商用吗？

@adapttive/vue-markdown 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

@adapttive/vue-markdown 的下载量有多少？

根据 npm 官方下载统计，@adapttive/vue-markdown 在 2026/10/05 – 2026/11/03 这 30 天内被下载 8,209 次，日均约 274 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

@adapttive/vue-markdown 还在维护吗？

最新版本 4.0.2 发布于 2022/08/28（4 年前）；至今共发布 20 个版本，其中过去 12 个月发布了 0 个；首次发布于 2020/12/19。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。