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

【版本】

• vue-cli3
• [email protected]

【步骤】

1、安装插件vue-markdown-loader

npm i vue-markdown-loader -D

该插件可以将markdown文件加载成vue组件。
ps：由于该插件是基于markdown-it的，因此不需要单独安装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>

由于我的网站是http，而markdown文件中引用的图片是https，于是在html中加上这个请求头信息：（视具体情况增加）

<meta name="referrer" content="no-referrer"/>

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

【动态引入md文件】

App.vue代码见下：

HTML部分

<section :is="articleComponent"></section>

JS部分

this.$options.components[registerName] = require(`@/assets/articles/${path}.md`).default
this.articleComponent = registerName;

注意，这里引入语句最后的".default"，根据版本不同视情况决定是否需要。

【坑】

由于需求方给我的Markdown文档的标题是这样的：

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

页面展示的结果是这样：

标题并没有被正确解析。
折腾了大半天才发现，这是由于标题的#井号和文字之间没有空格导致的。证明见下：

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);//重点在这里！！！
        }
      })
  }
}

这样就能正确解析了。
不过这只是为了能快速见效想出来的临时方案，用两套markdown解析感觉就重复了。有时间再想更好的办法吧。

END