Vue3 使用marked【代码高亮,安装使用教程】

1.安装包

  • marked:转换markdown语法为HTML
  • highlight.js:高亮代码块
npm install marked @types/marked highlight.js -S

请添加图片描述

2.导入使用

当前项目的技术栈是Vue3 + TS

<template>
  <n-input type="textarea" v-model:value="value" @input="change" />
  <div v-html="markdownToHtml" class="markdown-body"></div>

</template>
<script lang="ts" setup>
import { marked } from 'marked';
import { ref, shallowRef } from 'vue';
import hljs from 'highlight.js'
import 'highlight.js/styles/foundation.css'

const render = new marked.Renderer()
marked.setOptions({
  renderer: render, // 这是必填项
  gfm: true,	// 启动类似于Github样式的Markdown语法
  pedantic: false, // 只解析符合Markdwon定义的,不修正Markdown的错误
  sanitize: false, // 原始输出,忽略HTML标签(关闭后,可直接渲染HTML标签)

	// 高亮的语法规范
  highlight: (code, lang) => hljs.highlight(code, { language: lang }).value,
})

const value = ref('**Hello,World**')
const markdownToHtml = shallowRef("")
markdownToHtml.value = marked(value.value)

const change = (value: string) => {
  markdownToHtml.value = marked(value)
}

</script>
<style>
</style>

一定要记得导入import 'highlight.js/styles/foundation.css'
否则代码将失去高亮效果

如需切换代码高亮的风格样式请前往highlight官方地址,修改foundation为你所想要的代码样式名称
在这里插入图片描述


最后呈现效果请添加图片描述

3.扩展使用

当然本文仅仅只是 演示输入框渲染 的,但是大部分情况我们前端需要渲染的markdown都是来自于后端接口

所以可以考虑将其封装为一个组件,将后端传入的值传入进来

### 回答1: 在 Vue 3 中实现代码一键复制功能,可以结合使用 `marked` 库和 `clipboard.js` 库来完成。下面是一个简单的示例: 1. 安装 `marked` 和 `clipboard.js` 库: ``` npm install marked clipboard --save ``` 2. 在需要使用代码高亮和复制功能的组件中,引入 `marked` 和 `clipboard` 库: ```javascript import marked from 'marked'; import ClipboardJS from 'clipboard'; ``` 3. 创建一个自定义指令,用于实现代码高亮和复制功能: ```javascript export default { mounted(el) { // 使用 marked 库将代码块渲染为 HTML const renderer = new marked.Renderer(); renderer.code = (code, lang) => { const hljs = require('highlight.js'); const validLang = hljs.getLanguage(lang) ? lang : 'plaintext'; return `<pre><code class="hljs ${validLang}">${hljs.highlight(validLang, code).value}</code></pre>`; }; const html = marked(el.textContent.trim(), { renderer }); // 将 HTML 渲染到页面中 const container = document.createElement('div'); container.innerHTML = html; el.parentNode.insertBefore(container, el); el.style.display = 'none'; // 添加复制按钮 const copyButton = document.createElement('button'); copyButton.className = 'copy-button'; copyButton.innerText = '复制'; container.appendChild(copyButton); // 初始化 ClipboardJS new ClipboardJS(copyButton, { text: () => code, }); }, }; ``` 4. 在需要使用代码高亮和复制功能的代码块上,添加自定义指令: ```html <pre v-copy> <code> // 这里是你的代码 </code> </pre> ``` 在上面的示例中,我们使用了 `v-copy` 自定义指令来为代码块添加复制功能。指令中的代码会在组件挂载后执行,将代码块渲染为 HTML 并添加复制按钮。当用户点击复制按钮时,代码块的文本内容将被复制到剪贴板中。 需要注意的是,这个示例中的代码高亮功能使用了 `highlight.js` 库,需要在组件中引入。此外,为了让 `ClipboardJS` 库正常工作,需要在 `mounted` 钩子函数中使用 `setTimeout` 延迟执行初始化代码,以确保 DOM 元素已经完全渲染到页面中。 ### 回答2: 在Vue3中,我们可以使用Vue指令和第三方库Marked来实现代码一键复制的功能。 首先,我们需要在项目中安装Marked库,可以使用npm命令或者yarn命令进行安装:npm install marked 或者 yarn add marked。 然后,可以在Vue组件中引入Marked库,并使用Vue指令来实现代码一键复制的功能。 在Vue组件的`<script>`标签中,可以引入Marked库:import marked from 'marked'; 接下来,在该组件中,可以使用Vue的`v-on`指令来绑定一个复制事件,并使用Marked库的功能来获取需要复制的代码。例如,在一个按钮上添加一个点击事件: <button v-on:click="copyCode">复制代码</button> 然后,在`methods`中定义一个`copyCode`函数来处理点击事件,并在该函数中使用Marked库的功能来复制代码。具体的实现可以使用`document.execCommand('copy')`来将代码复制到剪贴板。代码如下所示: ``` methods: { copyCode() { // 获取需要复制的代码 const code = this.getCode(); // 创建一个input元素 const input = document.createElement('input'); input.setAttribute('value', code); document.body.appendChild(input); // 选择input中的文本 input.select(); // 复制选中的文本 document.execCommand('copy'); // 删除input元素 document.body.removeChild(input); }, // 获取需要复制的代码 getCode() { // 使用Marked库的功能来获取需要复制的代码 // 在这里获取代码的方法会根据具体的业务场景而不同 } } ``` 在`getCode`函数中,可以使用Marked库的功能来获取需要复制的代码。具体的获取代码的方法会根据具体的业务场景而不同。 综上所述,使用Vue指令和Marked库,我们可以实现Vue3中的代码一键复制功能。 ### 回答3: 要在Vue 3中实现一键复制代码,可以使用插件vue-clipboard2。这个插件基于剪贴板API,提供了一套易于使用的复制功能。 首先,需要安装vue-clipboard2插件。可以通过npm运行以下命令进行安装: ``` npm install vue-clipboard2 ``` 安装完成后,在Vue 3项目中,可以通过在main.js文件中引入并使用插件。如下所示: ```javascript import VueClipboard from 'vue-clipboard2'; createApp(App) .use(VueClipboard) .mount('#app'); ``` 然后,在组件中使用复制功能。例如,在一个代码块组件中可以添加一个复制按钮,并在按钮点击事件中调用复制函数。如下所示: ```html <template> <div> <pre><code>{{ code }}</code></pre> <button @click="copyCode">复制代码</button> </div> </template> <script> export default { data() { return { code: '代码内容' }; }, methods: { copyCode() { this.$clipboard.copy(this.code) .then(() => { console.log('代码已复制'); }) .catch(() => { console.error('复制失败'); }); } } }; </script> ``` 在上述代码中,我们在组件的data选项中定义了一个code属性,它包含待复制的代码内容。然后,在copyCode方法中,通过调用`this.$clipboard.copy`函数并传递代码内容来执行复制操作。 当复制按钮被点击时,代码将复制到剪贴板。我们可以根据返回的Promise进行相应的处理。如果复制成功,`then`回调函数将被调用,否则,`catch`回调函数将被调用。 这样,我们就可以通过vue-clipboard2插件在Vue 3中实现代码一键复制的功能了。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值