joplin-blog

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

1. Navigate to the relevant directory at the command line
2. Add dependencies yarn add -D joplin-blog.
3. add a configuration file .joplin-blog.json (see configuration for details)
4. add an npm script file "gen": "joplin-blog blog" (if you want to generate a wiki then "gen": "joplin-blog wiki")
5. Run the command yarn gen 6.
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.

• blog hexo
• blog vuepress
• wiki vuepress
• wiki docsify

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 note id (only valid under fluid topic)

I've shared over 190 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

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.

Why did the note id of the exported blog, wiki change?

Some possible reasons are

• Export jex and then import jex, all notes here are created operations, refer to: https://discourse.joplinapp.org/t/when-will-joplin-modify-the-id-of-the-note/17806
• Notes conflict when syncing