markdown-it-vue3 1.0.0 → 1.1.0

package/LICENSE

@@ -0,0 +1,31 @@
+MIT License
+
+Copyright (c) 2026 Nico
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+-------------------------------------------------------------------------------
+
+Third-Party Copyright Notice
+
+This project includes code based on or referenced from ravenq/markdown-it-vue,
+which is licensed under the MIT License:
+https://github.com/ravenq/markdown-it-vue/blob/master/LICENSE
+
+Copyright (c) 2019 ravenq

package/README.md

@@ -1,6 +1,24 @@
 # markdown-it-vue3
+[![npm version](https://img.shields.io/npm/v/markdown-it-vue3)](https://www.npmjs.com/package/markdown-it-vue3)
+[![license](https://img.shields.io/npm/l/markdown-it-vue3)](https://www.npmjs.com/package/markdown-it-vue3)
+[![vue 3](https://img.shields.io/badge/vue-3.x-42b883)](https://vuejs.org/)
 
-> Vue 3 markdown rendering library based on [markdown-it](https://github.com/markdown-it/markdown-it)
+
+> Vue3 版本的 markdown 流式渲染组件。<br>
+> A Vue 3 markdown rendering component support streaming, built on top of [markdown-it](https://github.com/markdown-it/markdown-it)
+
+## Features
+
+- Emoji, Subscript, Superscript, Footnotes
+- Task lists, Definition lists
+- KaTeX/LaTeX math
+- Mermaid, ECharts, Flowchart diagrams
+- Code highlighting with copy button
+- Image viewer
+- Alert containers: `::: success/info/warning/error`
+- **Streaming support** for AI chat scenarios
+
+* Demo: https://niyongsheng.github.io/markdown-it-vue3/
 
 ## Install
 
@@ -10,61 +28,43 @@ npm install markdown-it-vue3
 
 ## Usage
 
+### Static Markdown
+
 ```vue
 <template>
-  <markdown-it-vue :content="content" />
+  <MarkdownItVue :content="content" />
 </template>
 
-<script>
+<script setup>
 import MarkdownItVue from 'markdown-it-vue3'
 import 'markdown-it-vue3/dist/markdown-it-vue3.css'
 
-export default {
-  components: { MarkdownItVue },
-  data() {
-    return { content: '# Hello World' }
-  }
-}
+const content = '# Hello World'
 </script>
 ```
 
-## Light Version
-
-Smaller bundle without Mermaid, ECharts, Flowchart:
-
-```javascript
-import MarkdownItVueLight from 'markdown-it-vue3/dist/markdown-it-vue3-light'
-import 'markdown-it-vue3/dist/markdown-it-vue3-light.css'
-```
+### Streaming Markdown (AI Chat)
 
-## Props
-
-| Prop | Type | Default | Description |
-|------|------|---------|-------------|
-| content | String | `''` | Markdown content |
-| options | Object | `{}` | Configuration |
+```vue
+<template>
+  <MarkdownItVueStreaming
+    :content="streamContent"
+    :streaming="isStreaming"
+    @render-complete="onComplete"
+  />
+</template>
 
-## Options
+<script setup>
+import { ref } from 'vue'
+import { MarkdownItVueStreaming } from 'markdown-it-vue3'
+import 'markdown-it-vue3/dist/markdown-it-vue3.css'
 
-```javascript
-{
-  markdownIt: { linkify: true },
-  katex: { throwOnError: false },
-  githubToc: { tocFirstLevel: 2, tocLastLevel: 3 },
-  mermaid: { theme: 'default' },
-  image: { viewer: true }
-}
+const streamContent = ref('')
+const isStreaming = ref(false)
+</script>
 ```
 
-## Features
-
-- Emoji, Subscript, Superscript, Footnotes
-- Task lists, Definition lists
-- KaTeX/LaTeX math
-- Mermaid, ECharts, Flowchart diagrams
-- Code highlighting
-- Image viewer
-- Alert containers: `::: success/info/warning/error`
+> 📖 **See [example](./example) for complete implementation**
 
 ## License
 

package/dist/demo.html

@@ -1 +1 @@
-<!doctype html><meta charset="utf-8"><title>markdown-it-vue3-light demo</title><script src="./markdown-it-vue3-light.umd.js"></script><link rel="stylesheet" href="./markdown-it-vue3-light.css"><script>console.log(markdown-it-vue3-light)</script>
+<!doctype html><meta charset="utf-8"><title>markdown-it-vue3 demo</title><script src="./markdown-it-vue3.umd.js"></script><link rel="stylesheet" href="./markdown-it-vue3.css"><script>console.log(markdown-it-vue3)</script>