4d0b4b82e2fa65ed587aeb7ee69caf45dabd71ac
Joplin to mdbook Website Generator
Export your joplin notes into a mdbook compatible format for easy website creation.
joplinexport
- 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
Settings
- The mdbook configuration files:
config.tomlandbook.tomlare responsible for all the settings for the website. See for detailed breakdown.
This project is a fork of the very skilled Stavros Korokithakis's Project
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", instead checks if the notebook/note is tagged with "blog"
Stavros' notes
This is a static website that gets autogenerated from a bunch of Joplin notes. I wrote a small script to read the notes, export them, and generate a static site. If you want to use the script and generate such a site for yourself, feel free to fork this repository.
Just run ./joplinexport, it will read the database and create a site like this one and upload it to GitLab pages.
You can see the final site at:
Description
Languages
Python
94.5%
Shell
5.4%
CSS
0.1%