https://github.com/codito/noted
Extracts annotations/highlights from documents (pdf etc.), ebook readers (kindle, koreader etc.) to markdown
https://github.com/codito/noted
annotations ebook ebook-reader epub highlights kindle kindle-clippings kindle-highlights koreader mobi notes pdf
Last synced: about 1 month ago
JSON representation
Extracts annotations/highlights from documents (pdf etc.), ebook readers (kindle, koreader etc.) to markdown
- Host: GitHub
- URL: https://github.com/codito/noted
- Owner: codito
- License: mit
- Created: 2021-03-01T07:25:00.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-04-01T09:10:54.000Z (2 months ago)
- Last Synced: 2025-04-02T19:51:37.755Z (2 months ago)
- Topics: annotations, ebook, ebook-reader, epub, highlights, kindle, kindle-clippings, kindle-highlights, koreader, mobi, notes, pdf
- Language: C#
- Homepage:
- Size: 3.15 MB
- Stars: 30
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Noted
**TL;DR** noted is a command line app to liberate your highlights and notes.
Noted extracts annotations embedded into documents (pdf), or collects them from
readers (kindle, or koreader). It tries to align them with the chapters and context to
produce a plain text markdown file.
## Features
**✓** Extracts annotations (highlights and notes) for documents and books
**✓** Extracts _context_ and _chapter headings_ along with the annotations
**✓** Supports `pdf`, `epub` and `mobi` files
**✓** Detects kindle `My Clippings.txt` files
**✓** Detects koreader `*.sdr` directories
**✓** Saves all the extracted information in markdown text
A note on how the author uses this tool: [My reading workflow](https://codito.in/my-reading-workflow/).
## Installation
If you've .NET Core 5.0 or above already installed, simply download the
`Noted..Portable..zip` file from the [latest release][release].
If you do not wish to install .NET Core 5.0, try the self contained app from
[latest release][release].
- Windows: `Noted..win-x64.zip`
- Linux: `Noted..linux-x64.zip`
[release]: https://github.com/codito/noted/releases
## Usage
```
Noted:
Extracts highlights and notes from documents and save them as markdown
Usage:
Noted [options]
Arguments:
Source document or directory of documents to extract annotations
Destination file or directory
Options:
-c, --context extract the paragraph containing an annotation [default: False]
-t, --toc extract table of contents and align annotations [default: True]
-v, --verbose enable verbose logging [default: False]
--version Show version information
-?, -h, --help Show help and usage information
```
### Examples
**Extract a koreader library**
Connect your reader device and use the KOReader documents library path. Noted will
look for `*.sdr` directories besides each book to extract annotations.
```
$ ./Noted test/assets /tmp/note
> Extracting test/assets/koreader/pg42324.epub
✓ Frankenstein by Mary Shelley
✓ 5 annotations in 39 sections
✓ Saved to /tmp/note/pg42324.md
> Extracting test/assets/koreader/the_prophet.epub
✓ The Prophet by Khalil Gibran
✓ 4 annotations in 34 sections
✓ Saved to /tmp/note/the_prophet.md
Completed in 0.65s.
```
**Extract a kindle library**
First, connect your kindle over usb and provide the path to `documents`
directory which contains `My Clippings.txt` file.
```
$ ./Noted /run/media/arun/Kindle/documents /tmp/kindle
> Extracting /run/media/arun/Kindle/documents/Epictetus/Enchiridion, The - Epictetus.mobi
✓ The Enchiridion by Epictetus
✓ 49 annotations in 58 sections
✓ Saved to /tmp/kindle/Enchiridion, The - Epictetus.md
Completed in 14.11s.
```
Now open the output file `/tmp/kindle/Enchiridion, The - Epictetus.md` and enjoy
your notes.
**Extract highlights from a pdf**
```
$ ./Noted /home/arun/papers/Chambliss_1989_The\ Mundanity\ of\ Excellence.pdf /tmp/kindle
> Extracting /home/arun/papers/Chambliss_1989_The Mundanity of Excellence.pdf
✓ The Mundanity of Excellence: An Ethnographic Report on Stratification and Olympic Swimmers
✓ 6 annotations
✓ Saved to /tmp/kindle/Chambliss_1989_The Mundanity of Excellence.md
Completed in 1.71s.
```
## Roadmap
- Support for `kfx` and `azw3` files in kindle
- Support for additional readers like `kobo` etc.
Contributions in any form e.g. bug reports, feature requests or PRs are most
welcome!
## License
MIT