Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dimasmith/highlights
A tool to convert highlights from Kindle application to various formats
https://github.com/dimasmith/highlights
kindle markdown obsidian
Last synced: 2 days ago
JSON representation
A tool to convert highlights from Kindle application to various formats
- Host: GitHub
- URL: https://github.com/dimasmith/highlights
- Owner: dimasmith
- License: mit
- Created: 2022-09-19T22:59:28.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2022-10-22T13:16:28.000Z (almost 2 years ago)
- Last Synced: 2024-09-21T14:04:46.881Z (6 days ago)
- Topics: kindle, markdown, obsidian
- Language: Rust
- Homepage:
- Size: 57.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Highlight Converter
Converts exported kindle highlights to other formats.
## Motivation
After reader finishes a Kindle book it is handy to place highlights from the book
into some readable format for revisiting it later.
The `highlights` utility is created to convert exported highlights to other formats
more suitable for placing into note-taking software.
## Installation
Use cargo to install the `highlights` tool locally:
```shell
cargo install highlights
```
## Usage
```shell
Usage: highlights [SOURCE] [TARGET]
Arguments:
[SOURCE] input file
[TARGET] output file
Options:
-h, --help Print help information
-V, --version Print version information
```
### Examples
Read highlights from the bookcision json file and render to the output stream.
```shell
highlights input.json
```
Read highlights from the bookcision json file and render to the file.
```shell
highlights kasparov.json kasparov.md
```
## Supported output formats
### Markdown
The highlights are suitable for importing into the Obsidian or similar software that works with Markdown format.
## Supported input formats
### Bookcision JSON
A free [bookcision](https://readwise.io/bookcision) service provides a way to export
kindle highlights to the json file.
Highlight support those files as an input.
## Samples
You can check resulting formatted highlights in `samples` directory.
- `default_markdown.md` - example of markdown highlights with default formatter;