Skip to content

Latest commit

 

History

History
118 lines (82 loc) · 3.49 KB

README.md

File metadata and controls

118 lines (82 loc) · 3.49 KB
Raw

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.

Installation

If you've .NET Core 5.0 or above already installed, simply download the Noted.<version>.Portable.<os>.zip file from the latest release.

If you do not wish to install .NET Core 5.0, try the self contained app from latest release.

  • Windows: Noted.<version>.win-x64.zip
  • Linux: Noted.<version>.linux-x64.zip

Usage

Noted:
  Extracts highlights and notes from documents and save them as markdown

Usage:
  Noted [options] <sourcePath> <outputPath>

Arguments:
  <sourcePath>    Source document or directory of documents to extract annotations
  <outputPath>    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