Skip to content

Extract highlights from Kobo e-reader into a markdown file

Notifications You must be signed in to change notification settings

martinfilliau/kobo-annotations

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

kobo-annotations

Project status: proof of concept

Extract annotations (highlights) from Kobo books into a markdown file.

Uses the .epub.annot XML file as a source.

Usage

Run cargo run -- /full/path/to/file

It will output a file at /full/path/to/file.md.

Tests

Run cargo test.

TODO

  • add tests
  • properly handle XML namespaces ?! (check this conversation)
  • separate into different files w/ own responsibility
  • handle lines return
  • add documentation (ADR, use cases...)
  • templatize output?
  • handle relative file path
  • customize output destination
  • (optionnally) use ebook to get highlight's context (e.g. nearest sub-title) ?
  • ability to use as a library as well as a CLI? (i.e. decouple lib and CLI) / modules
  • version
  • generalize result pattern

About

Extract highlights from Kobo e-reader into a markdown file

Topics

Resources

Stars

Watchers

Forks

Languages