Vue Markdown component based on marked library ๐๐
Install
yarn add vue-markdown-wrapper # - or - npm install vue-markdown-wrapper
Usage Example
<template> <div> <VueMarkdown :md="this.md"></VueMarkdown> </div> </template> <script lang="ts"> import { VueMarkdown } from 'vue-markdown-wrapper'; export default defineComponent({ data() { return { md: null, }; }, async mounted() { // FETCH MARKDOWN SAMPLE const __md = await (await fetch('/sample01.md')).text(); this.md = __md as any; }, }); </script>
Results
Component Props
Key NameRequiredExampleDefault ValueDescriptionmd
Yes__hello__null
The markdown textsilent
Notrue | falsefalse
If true, the parser does not throw any exception or log any warning. Any error will be returned as a string.breaks
Notrue | falsefalse
If true, add on a single line breakgfm
Notrue | falsetrue
Use approved Github Flavoredpedantic
Notrue | falsefalse
Conform to the original markdown.pl
Contributing to this project
PRs and Issues are welcome. ๐
License
Copyright ยฉ thewolfx41 โ Released under the MIT License.