diff --git a/Highlight-export.md b/Highlight-export.md index eafe5e7..4516eff 100644 --- a/Highlight-export.md +++ b/Highlight-export.md @@ -1,7 +1,38 @@ -The bundled highlight export plugin is able to export [highlights](https://github.com/koreader/koreader/wiki/Clipboard) and notes added from both native reader in Kindle and the Koreader itself to [Joplin](https://joplinapp.org) and [Readwise](https://readwise.io) as well as local JSON, HTML, or TXT files. +The bundled highlight export plugin is able to export [highlights](https://github.com/koreader/koreader/wiki/Clipboard) and notes added from both native reader in Kindle and the Koreader itself to [Joplin](https://joplinapp.org) and [Readwise](https://readwise.io) as well as local JSON, HTML, Markdown, or TXT files. This plugin replaces the deprecated [Evernote export](https://github.com/koreader/koreader/wiki/Evernote-export). -### Readwise Authorization Token +## Setup Instruction +You can select one or more export targets from the **Export Highlights > Choose Formats**. -Get your Readwise authorization token from here: https://readwise.io/access_token \ No newline at end of file +### Readwise +Get your Readwise authorization token from here: https://readwise.io/access_token + +### Joplin +#### Auth Token +You can enter your auth token on your computer by saving an empty token. Then quit KOReader, edit the exporter.joplin_token field in %1/settings.reader.lua after creating a backup, and restart KOReader once you're done. + +#### Port Forwarding +To export to Joplin, you must forward the IP and port used by this plugin to the `localhost:port` on which Joplin is listening. This can be done with `socat` or a similar program. For example: + +For Windows: + +```cmd +netsh interface portproxy add v4tov4 listenaddress=0.0.0.0 listenport=41185 connectaddress=localhost connectport=41184 +``` + +For Linux: + +```bash +socat tcp-listen:41185,reuseaddr,fork tcp:localhost:41184 +``` + +### Markdown Formatting +You can configure Markdown formatting by navigating to **Export Highlights > Choose Formats and Services > Markdown**. + +## Usage +There are two export options are available: +1. Export all notes in this book +2. Export all notes in your library + +Upon exporting this plugin will export notes to all enabled targets.