Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/newswangerd/kindle-notes
https://github.com/newswangerd/kindle-notes
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/newswangerd/kindle-notes
- Owner: newswangerd
- Created: 2021-03-31T18:51:58.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-04-05T21:11:02.000Z (over 3 years ago)
- Last Synced: 2024-10-30T06:44:54.472Z (about 2 months ago)
- Language: Python
- Size: 13.7 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Installation
```shell
git clone [email protected]:newswangerd/kindle-notes.git
pip install -e kindle-notes
```
# Usage
## Taking Notes
`kindle-notes` allows insterting some basic formatting on your kindle while you're taking notes. For example, highlighting a piece of text and adding `-` or `#`, `##`, `###`... etc will format the highlighted block of text with the selected markdown formatter.
For example highlighting "Example Heading" with `##` will result in:
```markdown
## Example Heading
```
In your exported notes. This can be used to mark chapter titles and subheadings to make it easier to get around your notes.
## Exporting Notes
To export your notes, simply copy the `My Clippings.txt` file off of your kindle and run the following commands
```shell
$ kindle-notes kindle-notes examples/My\ Clippings.txt
0. My Example Book
Select a book: 0
Removing duplicates 0
Notes saved to /home/david/code/kindle-notes/examples/My Example Book.md.
```
This will produce the following markdown file, which you can see here: [Example Notes](examples/My%20Example%20Book.md)
```
# My Example Book
- I'm a note! (location 3286)
> I'm a highlight with a note. (3285-3286)
### I'm a level 3 header (3588-3588)
> I'm another highlight (3588-3588)
- I'm a highlight that will appear as a bullet. (3600-3600)
```
**NOTE** `My Clippings.txt` can only create new entries. Changing an existing highlight or note will simply create a new entry in `My Clippings.txt`. Kindle notes does it's best to try and de duplicate these entries by using the latest entry for each location that's indexed, but this method isn't perfect and your mileage may vary.