From efabee0eb5fef082b09105a044257bf00df8bac9 Mon Sep 17 00:00:00 2001 From: Yuriy Date: Thu, 11 Jul 2024 01:06:32 -0400 Subject: [PATCH] readme --- README.md | 14 +++----------- 1 file changed, 3 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 1869ef1..f2d2f06 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,10 @@ Export your joplin notes into a [mdbook](https://rust-lang.github.io/mdBook/inde ![Preview](static/preview.png "Preview") +## Settings +- The mdbook configuration files: `config.toml` and `book.toml` are responsible for all the settings for the website. See [mdbook configuration](https://rust-lang.github.io/mdBook/format/configuration/index.html) for a detailed breakdown. -## joplinexport +## 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. @@ -12,16 +14,6 @@ Export your joplin notes into a [mdbook](https://rust-lang.github.io/mdBook/inde - 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. - - - - - - - - # This project is a fork of [Stavros' notes](https://gitlab.com/stavros/notes/) ## Notable Changes