Vuepress如何做到在 Markdown 中使用 Vue 语法

2020-03-03 20:18:21

参考地址 深入浅出 VuePress(一)

前言

在 vuepress 刚出时,我就觉得这是个很值得追更的开源项目。果不其然,里面众多的前端编程技巧让我受益良多。

于是在周末这种日子里,人家追剧我追码。

今天,我就和大家分享下 vuepress 是如何做到在 Markdown 中使用 Vue 语法的。

原理

众所周知,Markdown 是一种标记语言,类似于 HTML,它也有对应的语法和词法。而 Vue 说白了也是一种语法,关键在于,Markdown 和 Vue 代码都可以被解释成 HTML。

聪明的读者应该想到了:添加一个中间过程,让 Vue 转成 Markdown 或者让 Markdown 转成 Vue,是不是就可以实现在 Markdown 中使用 Vue 语法了呢?

让我们再考虑一下两个方案的实现难点:

  1. Vue -> Markdown:template 和 style 部分还好,可 js 部分怎么办?

  2. Markdown -> Vue:可以将 markdown 代码解释成 html 或者 js 混入到 vue 代码中。

很显然,第二种方案实现起来更靠谱些,所以尤雨溪也是这样选的:


vuepress 在 Markdown 中使用 Vue 语法原理

在语法之间的转换工作上,webpack  的 loader 可是很擅长的。所以,vuepress 自定义了一个 markdownLoader 来将 Markdown 转成 Vue,再通过 vue-loader 得到最终的 HTML。

代码实现

markdownLoader

这是一个自定义的 loader,可参考如何编写一个 loader?

  1. 这个 loader 接收一个参数,里面包含一个 markdown-it 实例,作者用它来把 markdown 解释成 html。

  2. 得到 html 后将之包裹在 template 标签内,返回。

`<template>\n` +
    `<div class="markdown">${html}</div>\n` +
`</template>\n`

主要过程其实就这两步。当然,vuepress 还在 markdownLoader 里做了很多其他的事情,比如解析 yaml front matter、推断标题、获取 markdown 里提升的 style、script 等标签。

自己实现一个 demo

接下来,大家可以跟我一起实现一个基本的 demo。完整代码可见 github

  1. 新建一个 Vue 项目
    我们使用 vue-cli(v2.9.6) 新建一个项目:


    vue-cli 新建项目

  2. 编写 markdownLoader

  • 2.1 引入 markdown-it

    npm install markdown-it --save
  • 2.2 新建 markdownLoader 文件

    const markdown = require('markdown-it')module.exports = function(src) {
      const html = markdown().render(src)
      return (
        `<template>\n` +
          `<div class="markdown">${html}</div>\n` +
        `</template>\n`
      )}
  • 2.3 在 webpack 的 module rules 配置中添加 markdownLoader

    {
      test: /\.md$/,
      use: [
        { loader: 'vue-loader' },
        {
          loader: require.resolve('./markdownLoader')
        }
      ]}
  1. 在 Vue 文件里使用 markdown 文件

  • 3.1 在 src/components 新建一个 markdown.md

## 我是一个 markdown 
{{1+2}}
  • 3.2 在 src/router/index 中引入 markdown

 const Markdown = () => import('@/components/markdown.md')
  • 3.3 将这个组件添加进路由里去

{
  path: '/md',
  name: 'Markdown',
  component: Markdown}

结果

在 Markdown 中使用 React(JSX) 语法

既然可以在 markdown 里写 vue,那在 markdonw 里面写 react 理论上也是可以实现的:让 markdownLoader 最后返回一个 React 组件,之后使用 babel-loader 转成 js。

这一次我们是将 markdown 转 jsx 再包裹在一个 React 组件(函数或者类)里:

return (
    `import React from 'react';
    ${registerComponent}
    function R() {
        return (
        <div>
            <div className="markdown">${html}</div>
        </div>)
    }
    export default R;\n`
)

有兴趣的读者可以自行实现完整的 react 版本的 markdownLoader 代码。

结语

本文实现的 demo 只对 markdownLoader 的关键步骤做了实现,实际上还有很多问题需要解决,如浏览器的 API 访问限制、代码块和高亮的处理等需要解决,这篇文章就不涉及了。



  • 2020-03-18 21:15:34

    使用canvas画布解决百度地图自定义图层全球连续显示问题

        基于百度地图的Web API进行自定义图层叠加时,默认的图层只能叠加到全球范围以内,即经度范围为[-180, 180],而无法将图层叠加到默认的全球范围以外,即经度范围超出了[-180, 180]之后,经纬度坐标会自动回归到(0, 0),而导致在地图拖拽时全球以外无法连续显示想要的图层,此时可以基于百度地图的自定义图层将经纬度坐标转为像素点使用画布canvas来解决该问题。解决后效果如下图所示: ———————————————— 版权声明:本文为CSDN博主「宏伟杰作」的原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接及本声明。 原文链接:https://blog.csdn.net/u011284073/article/details/80549950

  • 2020-03-18 21:18:01

    node-canvas实现百度地图个性化底图绘制

    随着nodejs的推出,node的并发和异步的强大能力,越来越多的得到应用,而且取得了非常不错的效果。 作为一个前端工程师对node.js自然有着一份更深的感情,跃跃欲试的心情,总希望能将它应用到产品中来。

  • 2020-03-18 21:19:28

    高德地图和canvas画图结合应用的一些感想(一)

    入了团队才发现,该项目前后端分离,后端工程师已就位主要实现接口,IOS端工程师也已就位,还差一个web前端工程师。背脊一凉,我之前虽然写过一些js和css,虽有点功底但是离前端工程师还是有距离的啊。在和朋友说明情况后,朋友也是胆大,让我试试,主要他实在找不到人了(也有可能目前前端工程师报价都太贵了,创业嘛,能节约就节约,能理解。。。),没办法,走一步算一步吧。

  • 2020-03-18 21:30:57

    基于OpenLayers实现地理围栏 谷歌百度高德地图都可以

    前言.因为项目有点特殊,需要接入谷歌地图实现地理围栏,因为谷歌地图的地理围栏接口相关接口并不完善,于是就换了一个思路,利用OpenLayers来实现地理围栏 openlayers 中文地址 http://weilin.me/ol3-primer/ch02/index.html 作者:zcty0701 链接:https://www.jianshu.com/p/60e88ee1e843 来源:简书 著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。