vue-cli3项目展示本地Markdown文件的方法
时间: 2024-05-04 09:21:07 浏览: 16
要在Vue项目中展示本地Markdown文件,可以使用`vue-markdown-loader`和`marked`库。
首先,需要安装这两个依赖项:
```bash
npm install vue-markdown-loader marked --save-dev
```
然后,在Vue组件中,使用`vue-markdown-loader`将Markdown文件转换为HTML,并使用`v-html`指令将HTML渲染到页面上。以下是一个示例组件:
```html
<template>
<div>
<div v-html="markdown"></div>
</div>
</template>
<script>
import markdownFile from '@/assets/my-documentation.md';
import marked from 'marked';
export default {
data() {
return {
markdown: '',
};
},
mounted() {
const renderer = new marked.Renderer();
marked.setOptions({
renderer,
gfm: true, // 支持 Github 风格的 Markdown
tables: true, // 支持表格语法
breaks: false, // 不支持回车换行
pedantic: false,
sanitize: false,
smartLists: true,
smartypants: false,
});
this.markdown = marked(markdownFile);
},
};
</script>
```
在上述示例中,`my-documentation.md`是位于`src/assets`目录下的Markdown文件。代码中使用了`marked`库将Markdown文件转换为HTML,并将其存储在组件的`markdown`数据属性中。`v-html`指令将HTML渲染到页面上。
请注意,`vue-markdown-loader`会将Markdown文件转换为Vue组件,因此在导入Markdown文件时,需要使用`@/`前缀。此外,还需要将`marked`库的选项进行配置,以便支持所需的Markdown语法。
希望这个回答能够帮助到你!