1.0.1 • Published 4 months ago
vue-markdown-viewer v1.0.1
vue-markdown-viewer
Vue component to render markdown with remark.
Install
$ npm install vue-markdown-viewer
Use
<script lang="ts" setup>
import { ref } from 'vue'
import { VueMdRender } from 'vue-markdown-viewer'
const md = ref('## hi')
</script>
<template>
<VueMdRender>{{ md }}</VueMdRender>
</template>
Use a plugin to support gfm:
<script lang="ts" setup>
import { ref } from 'vue'
import { VueMdRender } from 'vue-markdown-viewer'
import remarkGfm from 'remark-gfm'
const md = ref('## hi')
</script>
<template>
<VueMdRender :remark-plugins="[remarkGfm]">
{{ md }}
</VueMdRender>
</template>
Use a plugin to support syntax highlight:
<script lang="ts" setup>
import { ref } from 'vue'
import { VueMdRender } from 'vue-markdown-viewer'
import rehypeHighlight from 'rehype-highlight'
const md = ref(`
## Highlight
\`\`\`js
console.log("hi")
\`\`\`
`)
</script>
<template>
<VueMdRender :rehype-plugins="[rehypeHighlight]">
{{ md }}
</VueMdRender>
</template>
Options
content
:string
\ markdown stringcomponents
:Record<string, Component>
\ object mapping tag names to Vue componentsremarkRehypeOptions
:Record<string, any>
\ Options of remark-rehyperemarkPlugins
:Array
\ list of remark plugins to userehypePlugins
:Array
\ list of rehype plugins to useclassName
:string
\ wrap the markdown in adiv
with this class nameskipHtml
:boolean
, default:false
\ ignore HTML in markdown completelylinkTarget
:string
\ target to use on links