VuePress源码阅读(三) -- 「成"站"之日」markdown建站分析篇

前置文章: VuePress源码阅读(一)--初探 VuePress VuePress源码阅读(二)--dev和build的执行流程分析

之前写了两篇文章来记录对 VuePress dev 和 build 执行过程的源码阅读记录,不过那只是为了学习 VuePress 所做的一点小调研,目的是对 VuePress 的整个执行流程有个大概的把控.

而 VuePress 在我看来更重要的是通过整合一系列技术,实现了仅靠 "markdown文件 + 配置" 快速构建网站的效果.

在 VuePress 官方首页将 VuePress 定义为:

  • 项目结构以 Markdown 为中心

  • 是一个技术栈为"Vue + vue-router + Webpack"的静态网站生成器

  • 会为每个页面预渲染生成静态 HTML,被加载后作为 SPA 运行(Vue SSR 赋能)

  • 想要构建一个最简网站,甚至不用配置文件,只需要一个 README.md 就能成站

前面两篇Vuepress源码分析的文章已经把整个 dev 和 build 的流程走过一遍了,现在我们对整个流程做一次整理:

VuePress流程

现在来思考一下整个流程中,VuePress 如何整合技术来实现 markdown 文件的建站.

一. 寻找编译 markdown 文件的库

markdown 是一种可用于在纯文本文档中添加格式化元素标记语言,故使用合适的转换工具将 markdown 文件编译成 HTML 文件,即可完成 Markdown 文件作为网站的展示.

现在看看 VuePress 是使用什么库来完成 markdown 文件编译为 HTML 文件的.

首先来到共享流程中的 app.process 阶段(node_modules/@vuepress/core/lib/node/App.js):

可以看到这里通过 createMarkdown 函数获取到了 markdown,然后我们先倒推看看 createMarkdown 来自哪里(node_modules/@vuepress/core/lib/node/createMarkdown.js):

这里的 siteConfig 其实就是 config.js 的配置,这里其实就是在 @vuepress/markdown 提供的 createMarkdown 前包装了一层,目的就是给 markdownConfig 配置添加两个属性.

我们继续追溯 @vuepress/markdown,其内部使用了 markdown-it-chain 实现对 npm 包 markdown-it 的内置插件管理,我们可以通过require('@vuepress/markdown') 来查看或者改变内部插件的启用停用,最后使用 const md = config.toMd(require('markdown-it'), markdown) 来返回一个 markdown-it 对象(就是变量 md).

那么什么是 markdown-it 呢?其实它是一个 markdown 的解析库,它能解析 markdown 文档,并将其渲染为 HTML 文档,官方 Demo 如下:

其用法简单来说就是使用一组配置来获取 markdown-it 提供的对象,这一步就是刚刚 markdown-it-chain 做的事情,然后用这个对象调用 render 即可~ 详细用法可见 https://markdown-it.github.io/markdown-it/

现在我们就已经找到了编译 markdown 文件的库了,接下来回头看看后续流程中是如何使用获得的 markdown-it 对象的.

二. markdown-it 对象的使用

回忆前面对于 VuePress dev 和 build 流程的分析(文章:VuePress源码阅读(二)--dev和build的执行流程分析),在 dev 和 build 的 process 函数中都会经历一个构建 Webpack 配置的阶段 prepareWebpackConfig,但是 dev 和 build 的 webpack 构建流程略有不同(左侧为 dev ,右侧为 build):

可以看到相同的是都调用了 "createClientConfig(即「客户端配置构建」)",不同的是:

  • dev 多了三个插件的引用

  • build 多了一个"createServerConfig(即「服务器配置构建」)",用于生成服务端渲染程序

无论是 createClientConfig还是createServerConfig 内部都调用了 createBaseConfig(即「基础配置构建」),之所以能够通过一个对象config来控制Webpack的配置,就是因为 config 对象是在 createBaseConfig 中通过 webpack-chain 构建,这是一个通过链式 API 来构建 webpack 配置的库,其生产的 config 对象就跟项目中的 webpack.config.js 一致,所以也可以把上面的 base、client、server 和平日的 webpack 配置文件联系起来~

createBaseConfig 全流程比较长就不截图了,大概就是把平时 webpack.config.js 中的配置写了一遍,这里只截一下在一堆 loader 中的 markdown-loader 的配置,这里显示它接收 .md 后缀文件然后使用 markdown-loader 处理:

这个 markdown-loader 也是 @vuepress 自带的,我们在里面找到了使用 markdown-it 对象调用 render函数生成 html 的代码:

ok,这样 markdown 文件"成站"的整个流程已经打通了~

欢迎拍砖,觉得还行也欢迎点赞收藏~ 新开公号:「无梦的冒险谭」欢迎关注(搜索 Nodreame 也可以~) 旅程正在继续 ✿✿ヽ(°▽°)ノ✿

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,809评论 6 513
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 94,189评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 167,290评论 0 359
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,399评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,425评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,116评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,710评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,629评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,155评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,261评论 3 339
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,399评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 36,068评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,758评论 3 332
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,252评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,381评论 1 271
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,747评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,402评论 2 358

推荐阅读更多精彩内容