源起

blog用过wp，hexo，hugo，都不甚满意，语雀的后台编辑功能是可以的，但是前端blog的展现就不适合本人，于是萌生一个语雀做后台，自己写前端站点的想法，就有了xugo-yuque

特性

  • 自动导入语雀平台数据，支持webhook，支持每日0点更新
    • 支持多知识库
  • 支持模版定制，对默认模版不满意？
    • 一套模版就几个页面，可以自己修改
    • 连接数据库，想怎样显示就怎样显示。
    • 对接xugo-yuque提供的接口
  • 提供api
    • 可以方便对接自家系统
    • 开发app应用

  • 支持自定义的page目录，支持相册目录

已知问题

  • 只支持“文档类型”的知识库
  • 不支持视频显示（语雀限制只能站内播放）
  • api 部分（含后台）启用后要先浏览器一下blog页面才能打开。
  • 语雀不支持外部图片，后台编辑全部都会转成语雀自己的图床，貌似做了防盗链处理。暂时通过下载图片到本地解决。
  • 部分较长或复杂文档（如大量代码），语雀api返回的html内容会截断，导致显示不全或错位。

对语雀建议

  • 去除图片防盗链，或者可以给用户自己设置。
  • 添加tag支持
  • 添加文章自定义字段，满足不同数据，以后做应用就直接用语雀做后台了，自己通过api做前端即可。
  • api 评论部分缺失。
  • 通过api保存的文档，不会触发webhook，例如剪藏

使用注意

  • 在与语雀交流过程中，语雀表示要优先保证自身产品体验，对于第3方api支持不会很及时。图片防盗链不会放开。
  • 求人不如求己，自己想办法解决了图片防盗链和内容截断，由于api限制，所以显示体验未必能和语雀一致。但好歹能完整显示了。
  • 数字序列使用顿号“、”，不要使用圆点“.”。
  • 如需使用本程序，建议在语雀后台尽量使用markdown进行编写，标题前后各空一行。
  • 语雀后台体验确实好，但是对于开放持保留态度，对于内容数据有些担心，有一天可能会被割韭菜。

安装

语雀设置

  • 创建账号token，给予最高可读权限。并且填写到xugo-yuque的配置文件
  • 将知识库webhook设置为http://{xugo-yuque-host}/webhook/yuque
  • 考虑到安全，webhook路径可以在配置文件自行设置

创建数据库

将sql目录下数据库脚本导入数据库。更新数据库链接信息至xugo-yuque的配置文件

Linux（centos）

  • 运行
nohup ./xugo-yuque start &

下载

linux-0.1.3 1、修复图片下载bug 2、自定义webhook路径，安全设置

后续计划

打赏累计超过1000元执行
1、支持将语雀markdown文档下载到本地
2、支持导入本地markdown文档，防止语雀失效

2024.11.27

由于最近一年语雀服务质量和内容变化很大，服务不稳定，数据不能导出，开放接口需要超级会员才能使用，逐放弃，本程序停更。新笔记组合为：Obsidian+Hugo，数据内容为本地md文件，备份简单，不怕数据绑架。

感谢

打赏

如果你喜欢，一分一毫也是对作者的鼓励(勿超10元)