yuriy/joplin-mdbooks-website
1
0
Fork 0
Code Issues 11 Pull Requests Packages Projects Releases Wiki Activity

readme

Browse Source
This commit is contained in:
Yuriy 2024-07-11 00:07:42 -04:00
parent 9ccf0c9650
commit 4d0b4b82e2
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -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. 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.