欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

vue-cli3项目展示本地Markdown文件的方法

程序员文章站 2022-09-02 14:19:43
【版本】 vue-cli3 webpack@4.33.0 【步骤】1、安装插件vue-markdown-loader npm i vue-m...

【版本】

  • vue-cli3
  • webpack@4.33.0

【步骤】1、安装插件vue-markdown-loader

npm i vue-markdown-loader -d

ps:这个插件是基于的,不需要单独安装markdown-it。

2、修改vue.config.js配置文件(如果没有,在项目根目录新建一个):

module.exports = {
 chainwebpack: config => {
  config.module.rule('md')
   .test(/\.md/)
   .use('vue-loader')
   .loader('vue-loader')
   .end()
   .use('vue-markdown-loader')
   .loader('vue-markdown-loader/lib/markdown-compiler')
   .options({
    raw: true
   })
 }
}

3、直接上代码

app.vue

<template>
 <my-markdown></my-markdown>
</template>

<script>
import mymarkdown from './assets/cpu.md';
export default {
 components: {
  mymarkdown
 },
</script>

正常情况下,到这里就结束了。

【坑】

由于业务给我的markdown文档的标题是这样的:

##物理cpu个数
物理cpu数就是主板上实际插入的cpu数量
……

得到的结果并不让我满意:

vue-cli3项目展示本地Markdown文件的方法

折腾了大半天才发现,这是由于标题的#井号和文字之间没有空格导致的。证明见下:

var markdownit = require('markdown-it'),
md = new markdownit();
console.log(md.render('# markdown-it rulezz!'))//<h1>markdown-it rulezz!</h1>
console.log(md.render('#markdown-it rulezz!'))//<p>#markdown-it rulezz!</p>

fine :)

愚蠢的我想出了一个解决办法:

因为hyperdown.js能避免上面那样的情况,于是我用它来对文档做预处理。

安装hyperdown.js

npm install hyperdown -d

然后把vue.config.js改成了这样。

let hyperdown = require('hyperdown');
let parser = new hyperdown;

module.exports = {
 chainwebpack: config => {
  config.module.rule('md')
   .test(/\.md/)
   .use('vue-loader')
   .loader('vue-loader')
   .end()
   .use('vue-markdown-loader')
   .loader('vue-markdown-loader/lib/markdown-compiler')
   .options({
    // markdown-it config
    preset: 'default',
    breaks: true,
    raw: true,
    typographer: true,
    preprocess: function(markdownit, source) {
     return parser.makehtml(source);//重点在这里!!!
    }
   })
 }
}

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。