Docusaurus 部署手册
-
这里记录着我搭建 Docusaurus 的部分踩坑过程,希望能够给正在搭建 Docusaurus 的小伙伴一些帮助,可行性均进行过验证。
-
本博客使用的是 Docusaurus 2.x 版本,是基于 docusaurus-theme-zen 主题。如果你喜欢我这个主题,源码是开源的,可以直接 fork 或者 git clone 均可,也可以通过 Vercel 一键部署
👇 建议多翻阅文官文档,或许会有你需要的答案
以下是分章节预览:
📄️ 环境配置
切换 Node 版本
📄️ 部署
在胡乱摸索 Docusaurus 的一些基本操作以及稍稍魔改一下主题之后,开始进行站点的云端部署。这里选择的是比较经济的做法,即部署的 Github 上。
📄️ 样式与页面
本文内容搬运自博主 kuizuo,原文地址:样式与页面
📄️ 自定义组件
本文内容搬运自博主 kuizuo,原文地址:自定义组件
📄️ 搜索配置
搜索功能是基于 algolia 来进行配置,配置方式有两种:
📄️ 评论系统
这里使用的是 Giscus,基于 Github Discussions,评论的信息可以通过 Github 邮箱发送,比较友好。
📄️ VSCode+PicGo+阿里云 配置图床
这里我选择的方案是 VSCode + PicGo + 阿里云,如果使用其他的图床,比如 GitHub、七牛云等也是类似的操作
📄️ 文档编辑指南
这里总结了一些我觉得自己比较常用的 Docusaurus 写作样式,参考自官方文档以及源码。
📄️ 使用 Hygen 创建文章模板
Docusaurus 目前并没有提供这样一种快速新建文章的方法,但 Markdown 需要设置一些前言字段或 import 一些组件,数据重复性的操作,每次写新文章的时候都要手动编写头部字段内容或者复制粘贴我嫌有点麻烦,于是引入了 Hygen 来解决这个问题,这是一个简单、快速、可扩展的代码生成器,其用途是帮助开发者自动创建模板文件的工具,旨在提高开发效率。
📄️ docs模板示例
docs的obsidian模板示例