joplin-blog

场景

将 Joplin 笔记发布为静态网站的 CLI 工具,目前支持 blog/wiki 两种形式,框架支持 hexo/vuepress/docsify。

blog demowiki demo

要求

  • 安装 nodejs 和 npm/yarn
  • 了解命令行
  • 了解 vscode

使用

非开发者安装指南

  1. 在命令行导航到相关目录
  2. 添加依赖 yarn add -D joplin-blog
  3. 添加配置文件 .joplin-blog.json(具体配置参考 配置
  4. 添加一个 npm script 脚本文件 "gen": "joplin-blog blog"(如果是要生成 wiki 则 "gen": "joplin-blog wiki"
  5. 运行命令 yarn gen
  6. 然后可以看到相关目录已经包含了笔记和附件资源

示例

支持的框架在 examples 目录中均有示例,你可以将之 clone 到本地查看。

配置

公共

配置类型说明
typehexo/vuepress/docsify/jeykll集成框架的类型
rootPathstringhexo/vuepress 目录,一般应该为 .
joplinProfilePathstringjoplin 个人文件夹
tokenstringjoplin web clipper 的 token
portnumberjoplin web clipper 的端口,一般是 41184
tagstring根据标签过滤需要导出的笔记

hexo

配置类型说明
stickyTopIdListstring[]置顶的笔记 id(仅在 fluid 主题open in new window 下生效)

我用这个工具分享了 190 多篇笔记,博客地址(中文)open in new window

常见问题

token/port 指的是什么,在哪儿可以找到?

一般可以在 工具 > 选项 > 网页剪辑器 中看到

joplin web clipper

joplin 个人文件夹在哪儿?

一般而言,如果你使用便携程序,它应该就是程序目录下的 ./JoplinProfile 目录,你应该可以在其中看到 resources、templates、tmp 目录。

joplinProfilePath

为什么导出的 blog、wiki 的笔记 id 变了?

一些可能的原因是

如何导出全部的笔记

设置 "tag": "" 以不做任何过滤导出所有标签的笔记。

Last Updated: 2021/10/4 下午8:34:40
Contributors: rxliuli