Skip to content

clach04/koreader-to-markdown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

KOReader to Markdown

Read bookmarks from KOReader sidecars to Markdown files per book, prefixed with the date you added the most recent bookmark

How-to

  1. Run pipenv install to install all dependencies from Pipfile
  2. Run make to download slpp.py
  3. Start your KOReader's SSH server without a password and make note of its IP address
  4. Make sure you can connect to it using ssh from your terminal. See this for more info
  5. Rename example.env to .env and add the host (IP address) and user (typically root) of your KOReader's SSH
  6. Run koreader-to-markdown.py
    1. If your SSH key requires a passphrase, you will be prompted
  7. Copy the result from output to your Obsidian vault, or wherever you want to have your highlights as Markdown

Credits

  • paramiko to read your KOReader's sidecars over SSH
  • python-dotenv to read the contents of .env
  • inquirer to ask for your SSH key's passphrase, if needed