joplin-blog
joplin-blog copied to clipboard
rxliuli
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...
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.
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 gen6. - 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
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.
rxliuli