跳到主要内容

Docusaurus 初体验!

· 阅读需 5 分钟
Yikai Cai
不知道该写什么的写博客爱好者

Docusaurus 是一个基于 React 的静态站点框架,在开箱即用的同时,提供了优雅的魔改方法。

Docusaurus Introducing


很早就有写博客的想法,但是一直没找到一个很对我胃口的框架。因为除了写博客这件事之外,我还希望能够大力魔改我用的博客框架。

——要开箱即用,又要高可玩性,还要详细的文档,如果能方便地用 JavaScript/TypeScript 添加自己想要的功能,用 CSS 改成自己喜欢的样式,就最好了。

之前用过一段时间的 MkdocsHexo ,它们都是很出色的框架,使用体验也很好,但就是不太能满足我的定制化需求:它们的插件系统要不就是用起来很麻烦,要不就是缺少文档。

后来用了一段时间的 VitePress ,当时以为自己找到了命中注定的那个框架:基于 Vue 和 Vite ,极高的可定制性;框架本身也并不复杂,代码不多,很快就能看完。我甚至写了一个 VitePress 的主题

VitePress 之旅

VitePress 的可定制性太强了!强的原因是 VitePress 本身的功能并不多。

它只做这么几件事:把 Markdown 用 markdown-itmdit-vue 翻译成 HTML ,处理一下各个文件之间的链接,然后嵌入到默认/自定义 Layout 中的 <Content />元素里,基本上就大功告成了。

而自定义 Layout 更是 100% Hackable 的逆天存在,它就是一个 Vue Component(顺便一提,VitePress 的 Markdown 中也支持插入 Vue Component),可以在运行时做自己想做的任何的事情。

在构建期间也可以通过自定义的 Build-Time Data Loader 构建出任意的自定义数据,例如博客框架里常用的博文列表(一般会加上分页),各篇文章的编辑日期和修改日期,以及各种其他的好玩的东西……

后来放弃 VitePress 的原因有两个,一个是 VitePress 的文档太弱了,另一个是 VitePress 和 Vite 强绑定,但是 Vite 太难懂了(而且文档也比较弱)。为了把我的自定义主题导出成 npm 包,费了九牛二虎之力都没有成功,最后只好作罢。

其实我大概知道问题在哪:因为我用了 UnoCSSVite 集成,所以除了用 npm 包分发代码之外,用户还需要额外进行 VitePress 的 Vite 配置,但我自己用新的环境尝试了几次,遇到了各种难以描述的奇怪的错误……总之失败了几次之后彻底失去耐心了.

我很热衷于自己造轮子,事实上造这个 VitePress 主题的过程中我已经造出了一个博客框架大部分必要的组成部分了。但是碰到奇怪的问题又找不到文档时,那种挫败感真的令人难受。

图标是一个小恐龙的静态站点框架

放弃 VitePress 之后决定寻找一个新的框架,网上冲浪了一段时间之后发现了 Docusaurus 这个好东西。基于 React ,文档非常详细(Docusaurus 的官网本身就是使用 Docusaurus 写的文档博客二合一网站),有开箱即用的博客框架,并且也支持定制化,而且这个定制的方式还很神奇……总之被圈粉了。

这个小恐龙的图标真的很魔性,越看越喜欢。

Docusaurus Docusaurus Keytar Docusaurus Speed

简单上手了一下,使用体验非常好:文档很丰富,甚至连 Frontmatter 都有文档

大悦,遂撰文记之。于是就有了你现在正在看的这篇文章以及这个网站。