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 01:06:32 -04:00
parent 92cbf3628b
commit efabee0eb5
1 changed files with 3 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -3,8 +3,10 @@ Export your joplin notes into a [mdbook](https://rust-lang.github.io/mdBook/inde
![Preview](static/preview.png "Preview") ![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: - 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 - 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. - 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. - 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. - 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/) # This project is a fork of [Stavros' notes](https://gitlab.com/stavros/notes/)
## Notable Changes ## Notable Changes