Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 1.11 KB

README.md

File metadata and controls

45 lines (31 loc) · 1.11 KB

Kindle Annotations to Markdown

A simple program to convert Kindle HTML annotations to a Markdown file

Features

  • Conversion of page bookmarks, text highlights, and notes to Markdown
  • Included reference positions of annotations
  • Automatic detection of annotation file's language (currently supported)

Usage

$ kindle_to_markdown --help
Usage: kindle_to_markdown [OPTIONS]

  A simple program to convert Kindle HTML annotations to a Markdown file.

Options:
  -i, --input-file PATH   Path to the Kindle annotations HTML file.
                          [required]
  -o, --output-file PATH  Path to the Markdown file.
  -p, --print-only        Only print Markdown to the console.
  --help                  Show this message and exit.

Installation

From PyPi

pip install kindle-to-markdown

From Source

Prerequisites:

  • python in a supported version available on your path.
  • Package manager poetry installed (e.g., python -m pip install poetry)
make
poetry run python -m kindle_to_markdown --help