Skip to content

项目简介

语雀+Elog+Vitepress+@Sugarat/theme主题,原来的yuque-vitepress更适合当官方文档页面,原作者也确实使用它来部署Elog的官方文档,于是抽空找了个主题缝合,github收录主题地址,最后选择了@Sugarat/theme,感谢@粥里有勺糖(drunkard)

仓库介绍

仓库主要在yuque-vitepress基础上整合@Sugarat/theme主题,实现用语雀写文档,发布后自动更新到博客,大部分教程内容可以在上面两个仓库找到,不在重复说明。

主要分为下面两部分

  • Elog :用来同步语雀文档
  • vitepress+@Sugarat/theme:负责博客运行

文档配置

根据文档说明.elog.env配置语雀信息

运行本项目

同步完整命令见elog文档,博客相关命令见主题文档

安装依赖

yarn install

同步语雀文档。注:因为同步命令经常使用,我把本地同步简化成了snyc ,和原yuque-vitepress 有点区别

yarn run sync

开发启动

shell
yarn run dev

构建

shell
yarn run build

预览产物

shell
yarn run serve

更新和升级

它们是两个独立的项目,都支持独立更新和升级,功能上也不存在耦合。

@sugarat/theme主题更新

shell

# 更新主题
pnpm add @sugarat/theme@latest

# 更新vitepress
pnpm add vitepress@latest

elog更新

elog upgrade

上次更新于: