Giter Site home page Giter Site logo

thoqbk / kindle-notes Goto Github PK

View Code? Open in Web Editor NEW
5.0 1.0 0.0 3.6 MB

Create flashcards with Spaced Repetition from your notes. Syncing notes and highlights from your Kindle.

TypeScript 96.15% HTML 1.57% CSS 2.27% Shell 0.01%
kindle vscode-extension vscode flashcards

kindle-notes's Introduction

Kindle Notes

Simple flashcards and notes extension. Ability to sync with Kindle.

You learn many interesting things every day by researching or reading books but easily forget if do not revise after some time. This extension allows you to:

  • create flashcards and notes in simple markdown format
  • sync notes and highlights from your Kindle and save them as flashcards
  • revise flashcards

I use this extension daily for my long-term memory. Hope it helps you as well!

Feature highlights

  • create flashcards and notes in simple markdown format
  • sync notes and highlights from Kindle
  • Spaced Repetition to revise flashcards
  • auto format and generate metadata for books and flashcards
  • provide links to open Kindle and Markdown while reviewing a flashcard

Get started

  • run command Kindle Notes: Open Flashcards Repo to view books in the repo
  • run command Kindle Notes: Study to revise a random book
  • (optional) run Kindle Notes: Sync Books, enter email and password to sync from Kindle
  • (optional) commit and push to Github

Preview

  • create flashcards

  • sync notes and highlights from Kindle

Commands

  • Kindle-notes: Open Flashcards Repo: to open the flashcards repo in VS Code
  • Kindle Notes: Study: study flashcards from a random books
  • Kindle Notes: Study This File: study flashcards from the current markdown book
  • Kindle Notes: Sync Books: to sync books from your Kindle. Notice that, the extension will ask you for email and password to login to Kindle. The credentials will be kept locally on your machine only.

Format

  • Follows CommonMark
  • Additional syntax for metadata and side seperator (%%)
---
id: id of the book     <-- auto generated
name: Name of the book
---

##                     <-- starting point of the flashcard
(frontside content)

%%                     <-- seperator between front and backside
(backside content)

<!--                   <-- flashcard metadata. Auto generated
src: kindle
hash: (hash value)     <-- to identify a flashcard in the book
page: 301              <-- page of the notes or highlights in Kindle
-->

##
Next flashcard

Configs

Name Description Default Value
Kindle notes: Flashcards Home Path Path to the flashcards repo directory. Will be asked the first time you use the extension
Kindle-notes: Headless Browser true to show Chromium browser while syncing notes and highlights from Kindle false
Kindle-notes: Show Logger Specify whether the logger UI will popup or not false
Kindle-notes: Kindle Email Email using to login to Kindle. Will be asked the first time you use the Sync Books command
Kindle-notes: Flashcards Per Study Session Number of flashcards in a study session 10

Release notes

v.0.0.7

  • Move db.json to tmp folder
  • Add action Study this file to editor title
  • Add strict when condition for Study this file

v.0.0.6

  • Sync note content from Kindle
  • Fix: missing flashcardsPerStudySession after sync
  • Align flashcard content to the left

kindle-notes's People

Contributors

thoqbk avatar

Stargazers

Aleksandar Tomašević avatar Christian Rotzoll avatar Lua Ort avatar  avatar Vladimir Lukiyanov avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.