From 4d0b4b82e2fa65ed587aeb7ee69caf45dabd71ac Mon Sep 17 00:00:00 2001 From: Yuriy Date: Thu, 11 Jul 2024 00:07:42 -0400 Subject: [PATCH] readme --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index f7ec133..10ec141 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,22 @@ Export your joplin notes into a [mdbook](https://rust-lang.github.io/mdBook/index.html) compatible format for easy website creation. +## joplinexport +- 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. + +# Settings +- The mdbook configuration files: `config.toml` and `book.toml` are responsible for all the settings for the website. See for detailed breakdown. + + + + + +