Skip to content

Justhiro55/Kioku

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

69 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Kioku Logo

Kioku (่จ˜ๆ†ถ)

A powerful flashcard learning extension for VSCode with spaced repetition

Version Installs CI License

Install from Marketplace | GitHub | Report Issue


๐ŸŒŸ Overview

Kioku (่จ˜ๆ†ถ - "memory" in Japanese) is a flashcard learning extension that integrates spaced repetition directly into VSCode. Learn programming languages, prepare for interviews, study foreign languagesโ€”all without leaving your editor.

Features:

  • ๐Ÿง  Spaced Repetition (SM-2 algorithm) for optimal retention
  • ๐Ÿ“ Markdown-based card creation (perfect for developers)
  • โŒจ๏ธ Keyboard-first navigation
  • ๐Ÿ“Š GitHub-style progress tracking
  • ๐ŸŽฏ 3 ready-to-use template decks included

โœจ Features

๐Ÿ  Home Screen

  • GitHub-style contribution calendar showing your learning progress
  • Quick access to all your decks with card counts
  • One-click deck creation and import
Home Screen

๐ŸŽฏ Spaced Repetition Learning

  • SM-2 Algorithm: Automatically schedules reviews based on your performance
  • Keyboard Navigation: Navigate everything with keyboard shortcuts
  • Undo System: Press Cmd+Z to undo your last rating
  • Progress Tracking: View statistics after each session
Review Screen

๐Ÿ“š Deck Management

  • Multiple Decks: Organize cards by topic, difficulty, or any way you like
  • Quick Browse: View all cards in a deck at a glance
  • Instant Add: Add new cards directly from the browse screen
  • Smart Filtering: See only cards that are due for review

๐Ÿ“ฅ Import & Export

  • ๐Ÿ“ Markdown Support: Import decks from markdown files (perfect for developers!)
  • ๐ŸŒ URL Import: Share and import decks via GitHub Gist or any markdown URL
  • ๐Ÿ“‹ One-Click Import: Button on home screen for instant deck creation
  • ๐Ÿ’พ Multiple Formats: CSV, JSON, and Markdown export options
  • ๐Ÿ“ฆ Templates Included: TOEIC vocabulary, ๅŸบๆœฌๆƒ…ๅ ฑๆŠ€่ก“่€…่ฉฆ้จ“, and JLPT N5 Japanese

๐Ÿ“ˆ Progress Tracking

  • ๐Ÿ“… Contribution Calendar: GitHub-style heatmap showing daily activity
  • ๐Ÿ”ฅ Streak System: Track consecutive learning days with visual indicators
  • ๐Ÿ“Š Detailed Statistics: Cards reviewed, accuracy rate, and time spent
  • ๐ŸŽฏ Performance Insights: See which decks need more attention

๐ŸŽฎ Gamification

  • โœจ Animated Completion: Beautiful celebration screen after each review
  • ๐Ÿ† Performance Badges: Get feedback based on your accuracy (Perfect! Excellent! Good Work!)
  • โฑ๏ธ Time Tracking: See how long you've been learning

๐Ÿš€ Installation

From VS Code Marketplace (Recommended)

  1. Open VSCode
  2. Press Cmd+Shift+X (Mac) or Ctrl+Shift+X (Windows/Linux)
  3. Search for "Kioku"
  4. Click Install

Or install directly from the marketplace โ†’

From Source

git clone https://github.com/Justhiro55/Kioku.git
cd Kioku
npm install
npm run compile
# Press F5 in VSCode to launch

๐Ÿš€ Quick Start

  1. Open Kioku: Click the ๐Ÿง  icon in the Activity Bar, then click Home
  2. Import a Template: Click ๐Ÿ“ฅ Import Deck from Markdown and select:
    • templates/toeic/golden-word.md - TOEIC vocabulary (100 words)
    • templates/kihon-joho/basic-terms.md - IT terminology (100 terms)
    • templates/japanese-learning/jlpt-n5-vocabulary.md - Japanese basics (150 words)
  3. Start Learning: Click โ–ถ Start Review and begin!

Or create your own deck:

  • Press Cmd+Shift+P โ†’ Kioku: Import from Markdown
  • Use AI (ChatGPT/Claude) to generate custom decks in Markdown format
  • See templates/README.md for the format

๐Ÿ’ก Usage

Creating Cards

From Markdown (Recommended for Developers! ๐Ÿš€)

Markdown Format: Create a .md file where H2 headings (##) are card fronts and paragraphs are backs:

# JavaScript Basics

## const
A constant variable declaration that cannot be reassigned

## let
Block-scoped variable declaration

## arrow function
Concise function syntax: (x) => x * 2

Import Methods:

  1. Via Command Palette (โŒ˜+Shift+P / Ctrl+Shift+P):

    • Type Kioku: Import from Markdown
    • Select your .md file
    • Cards are automatically created
  2. Via Home Screen:

    • Click Home in the Kioku sidebar
    • Click ๐Ÿ“ฅ Import Deck from Markdown
    • Select your markdown file
    • Done! Cards appear instantly
  3. From Current File:

    • Open any .md file in the editor
    • Run Kioku: Create Cards from Current Markdown File
    • Instant import without file picker

Quick Add

  1. Browse a deck
  2. Click + Add Card
  3. Enter front and back
  4. Press Cmd+Enter to save

Reviewing Cards

Keyboard Shortcuts:

  • Space / Enter - Show answer
  • 1 - Again (< 1 min)
  • 2 - Hard (< 10 min)
  • 3 - Good (1 day)
  • 4 - Easy (4 days)
  • Cmd+Z / Ctrl+Z - Undo last rating
  • Cmd+Delete / Ctrl+Backspace - Back to home

Rating Guide:

  • Again ๐Ÿ”„: Completely forgot
  • Hard ๐Ÿ˜…: Struggled to recall
  • Good โœ…: Recalled correctly
  • Easy โšก: Instant recall

Managing Decks

From Home Screen:

  • ๐Ÿ“– Browse: View all cards in deck
  • + Add Card: Quickly add new cards
  • โ–ถ Review: Start reviewing (only shown if cards are due)

Keyboard Navigation:

  • Cmd+Delete anywhere to return home
  • Cmd+Enter to save new cards

๐ŸŽจ Templates & Custom Decks

Kioku includes 3 ready-to-use template decks:

  • ๐Ÿ‡ฌ๐Ÿ‡ง TOEIC Golden Words - 100 business vocabulary (600 level)
  • ๐Ÿ’ป ๅŸบๆœฌๆƒ…ๅ ฑๆŠ€่ก“่€…่ฉฆ้จ“ - 100 IT terms for FE exam
  • ๐Ÿ‡ฏ๐Ÿ‡ต JLPT N5 Vocabulary - 150 basic Japanese words

Create Custom Decks with AI: Use ChatGPT or Claude to generate custom learning decks for any topic:

Prompt: "Create a flashcard deck in Markdown for React Hooks.
Use H2 headings (##) for card fronts and paragraphs for backs.
Create 50 cards."

๐Ÿ“– Full template documentation & examples โ†’

โš™๏ธ Settings

Access via Preferences > Settings > Kioku

  • kioku.useWebview - Use modern webview UI for reviews (default: true)
  • kioku.reviewAlgorithm - Choose algorithm: "sm2" or "basic" (default: "sm2")
  • kioku.storageType - Storage backend: "globalState" or "sqlite" (default: "globalState")

๐ŸŽฏ Commands

Open Command Palette (Cmd+Shift+P / Ctrl+Shift+P) and type:

Learning

  • Kioku: Show Home - Open home screen
  • Kioku: Start Review - Begin review session
  • Kioku: Add from Selection - Create card from selected text

Organization

  • Kioku: New Deck - Create a new deck
  • Kioku: Delete Deck - Delete a deck
  • Kioku: Browse Cards - View cards in a deck

Import/Export

  • Kioku: Import from Markdown - Import deck from file
  • Kioku: Create Cards from Current Markdown File - Quick import
  • Kioku: Export to Markdown - Export deck
  • Kioku: Import Deck from URL - Import from Gist or URL
  • Kioku: Share Deck - Copy deck to clipboard for sharing

Analytics

  • Kioku: Show Statistics - View detailed learning statistics

๐Ÿ”ฌ How It Works

Spaced Repetition (SM-2 Algorithm): Kioku automatically schedules reviews based on your performance:

  • Know a card well? See it less frequently
  • Struggling with a card? See it more often
  • Scientifically proven for optimal long-term retention

Storage:

  • GlobalState (default) - Lightweight, built into VSCode
  • SQLite - For large decks (switch in settings)

๐Ÿค Contributing

Contributions are welcome! Here's how you can help:

  1. โญ Star the repository
  2. ๐Ÿ› Report bugs
  3. ๐Ÿ’ก Suggest features
  4. ๐Ÿ”ง Submit pull requests

๐Ÿ“„ License

MIT ยฉ Justhiro55

๐Ÿ™ Support

If you find Kioku helpful:


About

An Anki-style flashcard extension for VSCode with spelling practice and GitHub-style streaks.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors