rxliuli / joplin-blog Goto Github PK

Are you as annoyed as I am with the trouble of maintaining notes and blogs in sync at the same time? If you use joplin as a note taking tool and hexo/vuepress as a blog generator, you can choose this tool to connect them.

Home Page: https://www.npmjs.com/package/joplin-blog

License: MIT License

TypeScript 98.49% JavaScript 1.51%

joplin hexo

joplin-blog's Introduction

Migrate to joplin-utils

joplin-blog

Introduction

CLI tool to publish Joplin notes as a static website, currently supports both blog/wiki forms, framework supports hexo/vuepress/docsify.

blog
- hexo
- vuepress
wiki
- vuepress
- docsify

Requirements

Install nodejs and yarn
Knowledge of command line
Understanding VSCode

Use

Navigate to the relevant directory at the command line
Add dependencies yarn add -D joplin-blog.
add a configuration file .joplin-blog.json (see configuration for details)
add an npm script file "gen": "joplin-blog blog" (if you want to generate a wiki then "gen": "joplin-blog wiki")
Run the command yarn gen 6.
Then you can see that the relevant directory already contains the notes and attached resources

examples

The supported frameworks have examples in the examples directory, which you can clone locally to see.

Configuration

public

configuration	type	description
`type`	`hexo/vuepress/docsify`	type of integrated blog
`rootPath`	`string`	hexo/vuepress directory, which should normally be `.`
`joplinProfilePath`	`string`	joplin personal folder
`token`	`string`	joplin web clipper's token
`port`	`number`	the port of the joplin web clipper, usually `41184`
`tag`	`string`	joplin's blog tag

hexo

configuration	type	description
`stickyTopIdList`	`string[]`	topped notes id (only works

under fluid topics (only works under fluid topics) |

I've shared over 170 notes with this tool, blog address (Chinese)

FAQ

What does token/port refer to and where can I find it?

You can usually see it in Tools > Options > Web Clipper

! joplin web clipper

Where is the joplin personal folder?

Generally speaking, if you are using a portable program, it should be in the program directory in the . /JoplinProfile directory, and you should see the resources, templates, tmp directory in there.

! joplinProfilePath

joplin-blog's People

Contributors

Stargazers

Watchers

Forkers

arjunbazinga thwaller cart88 cyining-cn

joplin-blog's Issues

exporting error

Here is the error log

(node:8772) UnhandledPromiseRejectionWarning: TypeError: Cannot read property 'includes' of undefined
at JoplinHexoIntegrated. (E:\Hexo\node_modules\joplin-blog\dist\JoplinHexoIntegrated.js:105:53)
at Generator.next ()
at fulfilled (E:\Hexo\node_modules\joplin-blog\dist\JoplinHexoIntegrated.js:24:58)
at processTicksAndRejections (internal/process/task_queues.js:93:5)
(Use node --trace-warnings ... to show where the warning was created)
(node:8772) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag --unhandled-rejections=strict (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 1)
(node:8772) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

.joplin-blog.json configuration doubts.

Hello!

This project looks like exactly what I was looking for!

I was trying to configure .joplin-blog.json , i'm not sure what

joplinProfilePath | string | joplin personal folder

tag | string | joplin's blog tag

refers to, can you please give an example?

I looked at the hexo and vue-press example tutorials but couldn't find the .joplin-blog.json file.

Thanks!

Arjun

求助：markdown 图片在post page 页面不加载

用本插件（joplin-blog）批量导出笔记之后，所有图片的地址都是(../resource/xxx.jpg)，
这个在被hexo g以后，生成的页面中。
1.主页图片会显示，因为该文件夹被导入到了resourse里面，相对位置正确（主页index和resourse都在根目录）
2.但是点击阅读更多以后，图片就不显示了，相对位置不对（post的index存在以日期为格式的文件夹里，而resourse在根目录）

求问博主图片都是怎么插入的

mistake correct

1.in readme, it shouldn't be [ "imp": "joplin-hexo"], but [ "imp": "joplin-blog"]
2.its not [token for joplin web service] , but [joplin web clipper]