joplin-blog

场景

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

• blog
  • hexoopen in new window
  • vuepressopen in new window
  • jeykllopen in new window
• wiki
  • vuepressopen in new window
  • docsifyopen in new window

要求

• 安装 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. 然后可以看到相关目录已经包含了笔记和附件资源

请将 .joplin-blog.json 和 .joplin-cache.json 两个文件添加到 .gitignore 忽略文件中，前者包含敏感信息 token，后者是自动生成。

示例

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

• blog hexoopen in new window
• blog vuepressopen in new window
• blog jeykllopen in new window
• wiki vuepressopen in new window
• wiki docsifyopen in new window

配置

公共

配置	类型	说明
type	hexo/vuepress/docsify/jeykll	集成框架的类型
rootPath	string	hexo/vuepress 目录，一般应该为 .
joplinProfilePath	string	joplin 个人文件夹
token	string	joplin web clipper 的 token
port	number	joplin web clipper 的端口，一般是 41184
tag	string	根据标签过滤需要导出的笔记

hexo

配置	类型	说明
stickyTopIdList	string[]	置顶的笔记 id（仅在 fluid 主题open in new window 下生效）

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

常见问题

token/port 指的是什么，在哪儿可以找到？

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

joplin 个人文件夹在哪儿？

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

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

一些可能的原因是

• 导出 jex 然后再导入 jex，这里的笔记全部都是创建操作，参考：https://discourse.joplinapp.org/t/when-will-joplin-modify-the-id-of-the-note/17806open in new window
• 同步时笔记发生冲突

如何导出全部的笔记

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