Joplin to mdbook Website Generator
Export your joplin notes into a mdbook compatible format for easy website creation.
Settings
- The mdbook configuration files:
config.tomlandbook.tomlare responsible for all the settings for the website. See mdbook configuration for a detailed breakdown.
joplinexport (Python)
- Connects to the local Joplin
database.sqlitefile and iterates through all the folders, notes and their individual tags. If the note has theblogtag, do the following:- Grab the contents of the note, resolve any links to other notes and replace them with the proper HTML path
- If the note has images or other resources, resolve and replace the filepath to the resource with the HTML path and then export the resource to the
/content/resourcesdirectory. - export the contents of the note to a .md file within the
/contentdirectory.
- Generates a
SUMMARY.mdfile within the/contentdirectory with each of the folders and notes that had theblogtag.- If there is a
Welcomenote with theblogtag, it will be placed at the top of theSUMMARY.mdfile before any other folders/notes, this will be the landing page of the website.
- If there is a
This project is a fork of Stavros' notes
Notable Changes
- Notes and Folders are grabbed based on a whitelist instead of a blacklist
- Instead of checking if a notebook/note is tagged with "private" and skipping it, checks if the note is tagged with "blog"
- "Welcome" note (Landing Page) can be located anywhere, as long as it has the "blog" tag
- Resources are stored in
\content\resourcesinstead of\static
Description
Languages
Python
94.5%
Shell
5.4%
CSS
0.1%
