mdbooks based website generated from my Joplin Notes database
Go to file
2024-07-17 00:17:00 -04:00
static readme and preview 2024-07-11 00:18:54 -04:00
.envrc Updates 2023-04-21 04:31:40 +03:00
.gitignore removed hardcoded emoji from notes and folders 2024-07-05 19:16:40 -04:00
.gitlab-ci.yml Download mdBook if it doesn't exist 2021-11-20 04:21:31 +02:00
.pre-commit-config.yaml Upgrade pre-commit 2023-11-23 14:03:02 +02:00
book.toml readme and config 2024-07-11 00:54:33 -04:00
build Updates 2022-03-01 00:25:19 +02:00
config.toml removed blog content, modified joplin export to export only notes/notebooks tagged with -blog-, readme update 2024-07-05 18:45:24 -04:00
joplinexport added resume note beneath Welcome 2024-07-17 00:17:00 -04:00
move_html_to_dir Fix search links 2022-01-18 18:17:13 +02:00
pullandstartmdbook.sh bash script to pull from joplin and start mdbook 2024-07-11 00:22:15 -04:00
README.md readme 2024-07-11 01:06:32 -04:00
update.sh Make links prettier 2021-11-20 17:22:59 +02:00

Joplin to mdbook Website Generator

Export your joplin notes into a mdbook compatible format for easy website creation.

Preview

Settings

  • The mdbook configuration files: config.toml and book.toml are responsible for all the settings for the website. See mdbook configuration for a detailed breakdown.

joplinexport (Python)

  • Connects to the local Joplin database.sqlite file and iterates through all the folders, notes and their individual tags. If the note has the blog tag, 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/resources directory.
    • export the contents of the note to a .md file within the /content directory.
  • Generates a SUMMARY.md file within the /content directory with each of the folders and notes that had the blog tag.
    • If there is a Welcome note with the blog tag, it will be placed at the top of the SUMMARY.md file before any other folders/notes, this will be the landing page of the website.

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\resources instead of \static