readme and preview

This commit is contained in:
Yuriy 2024-07-11 00:18:54 -04:00
parent 4d0b4b82e2
commit 0b07f46109
2 changed files with 6 additions and 22 deletions

View File

@ -1,6 +1,8 @@
# Joplin to mdbook Website Generator # Joplin to mdbook Website Generator
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.
![Preview](static/preview.png "Preview")
## joplinexport ## 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: - 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:
@ -21,27 +23,9 @@ Export your joplin notes into a [mdbook](https://rust-lang.github.io/mdBook/inde
# This project is a fork of the very skilled [Stavros Korokithakis's Project](https://gitlab.com/stavros/notes/) # This project is a fork of[Stavros' notes](https://gitlab.com/stavros/notes/)
## Notable Changes ## Notable Changes
- Notes and Folders are grabbed based on a whitelist instead of a blacklist - Notes and Folders are grabbed based on a whitelist instead of a blacklist
- Instead of checking if a notebook/note is tagged with "private", instead checks if the notebook/note is tagged with "blog" - 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`
Stavros' notes
==============
This is a static website that gets autogenerated from a bunch of [Joplin](https://joplinapp.org/) notes.
I wrote a small script to read the notes, export them, and generate a static site.
If you want to use the script and generate such a site for yourself, feel free to fork this repository.
Just run `./joplinexport`, it will read the database and create a site like this one and upload it to GitLab pages.
You can see the final site at:
https://notes.stavros.io

BIN
static/preview.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 177 KiB