yifan-gu / blueNote

A Reading Notes/Clippings Browser

blueNote

A Notes/Clippings Browser

Build

git clone [e-mail]:yifan-gu/blueNote.git && go build
./blueNote -h

Usage

Export notes as html using the Kindle App

Convert notes to JSON and display them in the console

./blueNote convert -i kindle-html -o json --json.pretty examples/kindle_html_single_book_example.html

Convert notes and store them into MongoDB

./blueNote convert -i kindle-html -o mongodb examples/kindle_html_single_book_example.html

Convert notes to org-roam files and save to the current dir

./blueNote convert -i kindle-html -o org-roam examples/kindle_html_single_book_example.html ./

Add -s if the book is a collection of multiple books

./blueNote convert -i kindle-html -o json --json.pretty -s examples/kindle_html_collection_example.html

Browse and edit the notes with tags with Emacs Org

Remember to run M-x org-roam-db-sync to sync the org-roam database

📖 Happy Notes Searching! 📖

References

• Doom Emacs: https://github.com/doomemacs/doomemacs
• Org-roam: https://www.orgroam.com/
• My Doom Emacs config: https://github.com/yifan-gu/.doom
• A custom Emacs theme I made for Org-roam mode based on leuven

TODO

Documentation

• Update README to reflect the json/mongodb based usage

Emacs org roam related:

• [Dropped] Roam module (fix bug)
• [Dropped] Check roam version

Parser/Exporter:

• Refactor book module
• Refactor configs for parser and exporter
• Fix location output
• Fix user notes content
• JSON exporter
• Optional author, title flag
• Stacktrace error
• List parsers and exporters
• MongoDB exporter
• JSON parser
• One click export from Kindle app
• Change parser/exporter type from string to safe type

Server Backend:

• Database storage
• Index, unique on digest
• Update storage interface
• Recompute digest
• Limit on return marks
• Timestamp(created, last modified)
• Server REST API?
• Graphql API READ
• Graphql API Create
• Graphql API Update
• Graphql API Delete
• Handle Graphql null fields?
• Graphql API tests, mocked storage

App:

• Create DB scheme for users
• Search by tags, keywords, book, author
• Show random notes/highlights every time
• Show connected notes
• Clickable with tags, book, author
• Manual update tags
• Ratings?
• Audio book
• Generate tags automatically
• Connected notes suggestion

Advanced functions:

• User ratings
• User comments?
• User profiles
• User upload audiobook readings?