vue中使用marked显示markdown文件

本文介绍如何使用marked库将Markdown文本转换成HTML格式,包括安装marked库的方法和在Vue.js项目中使用marked的具体实现。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

1、安装marked

npm install marked

2、使用

<div v-html="readmeContent">

</div>

<script>
  //引入marked
  import marked from 'marked'
  
  export default {
    methods: {
      getMardownFileContent(data) {
		//处理markdown数据,data为markdown文件读出的字符串
		this.readmeContent = marked(data || '', {
		  sanitize: true
		}); 
    },
  }
  
</script>

 

### 如何在 Vue 3 项目中使用 `vue-markdown` 为了在 Vue 3 中集成并使用 `vue-markdown` 组件,可以按照如下方法操作: #### 安装依赖 首先,在终端执行命令安装必要的 npm 包。 ```bash npm install vue-markdown-render ``` 由于 `vue-markdown` 已不再维护,推荐使用其替代品 `vue-markdown-render` 来处理 Markdown 文件渲染[^1]。 #### 修改配置文件 编辑项目的 Vite 或 Webpack 配置文件来支持 `.md` 扩展名解析。对于基于 Vite 的构建工具来说,可以在 `vite.config.ts` 添加相应的插件设置: ```typescript // vite.config.ts import { defineConfig } from 'vite' import vue from '@vitejs/plugin-vue' import markdown from 'vite-plugin-md' export default defineConfig({ plugins: [ vue(), markdown() ] }) ``` 这段代码引入了用于加载和编译 Markdown 文件的插件[^4]。 #### 创建组件 创建一个新的单文件组件 (SFC),比如命名为 `MarkdownViewer.vue`,并将它加入到应用中的其他部分作为子组件使用。 ```html <!-- src/components/MarkdownViewer.vue --> <template> <section v-html="compiledMarkdown"></section> </template> <script setup lang="ts"> import { ref, computed, watchEffect } from 'vue'; import * as marked from 'marked'; const props = withDefaults(defineProps<{ source?: string; }>(), { source: '' }); const compiledMarkdown = computed(() => marked(props.source)); watchEffect(() => console.log('Compiled:', compiledMarkdown.value)); </script> ``` 此 SFC 使用了来自 `props` 属性传递的内容字符串,并通过计算属性将其转换成 HTML 片段显示出来[^3]。 #### 注册全局或局部组件 最后一步是在根实例或者其他父级组件里注册这个新定义好的 `MarkdownViewer` 组件以便于后续调用。 如果希望在整个应用程序范围内都能访问该组件,则可以通过扩展默认导入的方式实现全局注册;反之亦然,仅需在特定页面内声明即可完成局部范围内的引用。 ```javascript // main.ts import { createApp } from 'vue' import App from './App.vue' import MarkdownViewer from './components/MarkdownViewer.vue' createApp(App).component('MarkdownViewer', MarkdownViewer).mount('#app') ``` 这样就完成了整个流程,现在应该能够在任何地方轻松嵌入 Markdown 文本并正确展示出来了。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

你认识小汐吗

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值