joplin-blog
场景
将 Joplin 笔记发布为静态网站的 CLI 工具,目前支持 blog/wiki 两种形式,框架支持 hexo/vuepress/docsify。
要求
- 安装 nodejs 和 yarn
- 了解命令行
- 了解 VSCode
使用
- 在命令行导航到相关目录
- 添加依赖
yarn add -D joplin-blog
- 添加配置文件
.joplin-blog.json
(具体配置参考 配置) - 添加一个 npm script 脚本文件
"gen": "joplin-blog blog"
(如果是要生成 wiki 则"gen": "joplin-blog wiki"
) - 运行命令
yarn gen
- 然后可以看到相关目录已经包含了笔记和附件资源
示例
支持的框架在 examples 目录中均有示例,你可以将之 clone 到本地查看。
配置
公共
配置 | 类型 | 说明 |
---|---|---|
type | hexo/vuepress/docsify | 集成博客的类型 |
rootPath | string | hexo/vuepress 目录,一般应该为 . |
joplinProfilePath | string | joplin 个人文件夹 |
token | string | joplin web clipper 的 token |
port | number | joplin web clipper 的端口,一般是 41184 |
tag | string | joplin 的博客标签 |
hexo
配置 | 类型 | 说明 |
---|---|---|
stickyTopIdList | string[] | 置顶的笔记 id(仅在 fluid 主题 下生效) |
我用这个工具分享了 170 多篇笔记,博客地址(中文)
常见问题
token/port 指的是什么,在哪儿可以找到?
一般可以在 工具 > 选项 > 网页剪辑器 中看到
joplin 个人文件夹在哪儿?
一般而言,如果你使用便携程序,它应该就是程序目录下的 ./JoplinProfile
目录,你应该可以在其中看到 resources、templates、tmp
目录。