{"id":15901162,"url":"https://github.com/codito/noted","last_synced_at":"2025-04-23T20:32:10.757Z","repository":{"id":39273746,"uuid":"343326132","full_name":"codito/noted","owner":"codito","description":"Extracts annotations/highlights from documents (pdf etc.), ebook readers (kindle, koreader etc.) to markdown","archived":false,"fork":false,"pushed_at":"2025-04-01T09:10:54.000Z","size":3303,"stargazers_count":30,"open_issues_count":4,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-02T19:51:37.755Z","etag":null,"topics":["annotations","ebook","ebook-reader","epub","highlights","kindle","kindle-clippings","kindle-highlights","koreader","mobi","notes","pdf"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codito.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-01T07:25:00.000Z","updated_at":"2025-03-14T21:07:07.000Z","dependencies_parsed_at":"2024-01-31T16:10:08.872Z","dependency_job_id":"89667d4e-d469-4a61-9312-7cc23daf6eba","html_url":"https://github.com/codito/noted","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codito%2Fnoted","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codito%2Fnoted/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codito%2Fnoted/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codito%2Fnoted/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codito","download_url":"https://codeload.github.com/codito/noted/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250509771,"owners_count":21442490,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["annotations","ebook","ebook-reader","epub","highlights","kindle","kindle-clippings","kindle-highlights","koreader","mobi","notes","pdf"],"created_at":"2024-10-06T11:01:43.630Z","updated_at":"2025-04-23T20:32:08.182Z","avatar_url":"https://github.com/codito.png","language":"C#","funding_links":[],"categories":["C# #"],"sub_categories":[],"readme":"# Noted\n\n**TL;DR** noted is a command line app to liberate your highlights and notes.\n\nNoted extracts annotations embedded into documents (pdf), or collects them from\nreaders (kindle, or koreader). It tries to align them with the chapters and context to\nproduce a plain text markdown file.\n\n## Features\n\n**✓** Extracts annotations (highlights and notes) for documents and books  \n**✓** Extracts _context_ and _chapter headings_ along with the annotations  \n**✓** Supports `pdf`, `epub` and `mobi` files  \n**✓** Detects kindle `My Clippings.txt` files  \n**✓** Detects koreader `*.sdr` directories  \n**✓** Saves all the extracted information in markdown text\n\nA note on how the author uses this tool: [My reading workflow](https://codito.in/my-reading-workflow/).\n\n## Installation\n\nIf you've .NET Core 5.0 or above already installed, simply download the\n`Noted.\u003cversion\u003e.Portable.\u003cos\u003e.zip` file from the [latest release][release].\n\nIf you do not wish to install .NET Core 5.0, try the self contained app from\n[latest release][release].\n\n- Windows: `Noted.\u003cversion\u003e.win-x64.zip`\n- Linux: `Noted.\u003cversion\u003e.linux-x64.zip`\n\n[release]: https://github.com/codito/noted/releases\n\n## Usage\n\n```\nNoted:\n  Extracts highlights and notes from documents and save them as markdown\n\nUsage:\n  Noted [options] \u003csourcePath\u003e \u003coutputPath\u003e\n\nArguments:\n  \u003csourcePath\u003e    Source document or directory of documents to extract annotations\n  \u003coutputPath\u003e    Destination file or directory\n\nOptions:\n  -c, --context     extract the paragraph containing an annotation [default: False]\n  -t, --toc         extract table of contents and align annotations [default: True]\n  -v, --verbose     enable verbose logging [default: False]\n  --version         Show version information\n  -?, -h, --help    Show help and usage information\n```\n\n### Examples\n\n**Extract a koreader library**\n\nConnect your reader device and use the KOReader documents library path. Noted will\nlook for `*.sdr` directories besides each book to extract annotations.\n\n```\n$ ./Noted test/assets /tmp/note\n\u003e Extracting test/assets/koreader/pg42324.epub\n ✓ Frankenstein by Mary Shelley\n ✓ 5 annotations in 39 sections\n ✓ Saved to /tmp/note/pg42324.md\n\n\u003e Extracting test/assets/koreader/the_prophet.epub\n ✓ The Prophet by Khalil Gibran\n ✓ 4 annotations in 34 sections\n ✓ Saved to /tmp/note/the_prophet.md\n\nCompleted in 0.65s.\n```\n\n**Extract a kindle library**\n\nFirst, connect your kindle over usb and provide the path to `documents`\ndirectory which contains `My Clippings.txt` file.\n\n```\n$ ./Noted /run/media/arun/Kindle/documents /tmp/kindle\n\n\u003e Extracting /run/media/arun/Kindle/documents/Epictetus/Enchiridion, The - Epictetus.mobi\n ✓ The Enchiridion by Epictetus\n ✓ 49 annotations in 58 sections\n ✓ Saved to /tmp/kindle/Enchiridion, The - Epictetus.md\n\nCompleted in 14.11s.\n```\n\nNow open the output file `/tmp/kindle/Enchiridion, The - Epictetus.md` and enjoy\nyour notes.\n\n**Extract highlights from a pdf**\n\n```\n$ ./Noted /home/arun/papers/Chambliss_1989_The\\ Mundanity\\ of\\ Excellence.pdf /tmp/kindle\n\n\u003e Extracting /home/arun/papers/Chambliss_1989_The Mundanity of Excellence.pdf\n ✓ The Mundanity of Excellence: An Ethnographic Report on Stratification and Olympic Swimmers\n ✓ 6 annotations\n ✓ Saved to /tmp/kindle/Chambliss_1989_The Mundanity of Excellence.md\n\nCompleted in 1.71s.\n```\n\n## Roadmap\n\n- Support for `kfx` and `azw3` files in kindle\n- Support for additional readers like `kobo` etc.\n\nContributions in any form e.g. bug reports, feature requests or PRs are most\nwelcome!\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodito%2Fnoted","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodito%2Fnoted","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodito%2Fnoted/lists"}