@shaankhosla/repeat 0.0.22 → 0.0.24

package/CHANGELOG.md

@@ -1,21 +1,15 @@
-## [0.0.22] - 2025-12-31
+## [0.0.24] - 2026-01-04
 
 ### 🚀 Features
 
-- Import from Anki (#17)
+- Use github pages for docs (#30)
+- Play media from cards (#31)
 
 ### 🐛 Bug Fixes
 
-- Remove dbg statement
-
-### 💼 Other
-
-- Fix release pipeline
-
-### 🚜 Refactor
-
-- Made the CLI experience better
+- Exclude unreviewed cards from FSRS histograms (#26)
+- Update precommit to use SQLX_OFFLINE mode (#27)
 
 ### ⚙️ Miscellaneous Tasks
 
-- Upgrade criterion
+- Update readme with docs badge

package/README.md

@@ -4,6 +4,9 @@
   <a href="https://github.com/shaankhosla/repeat/actions/workflows/ci.yaml">
     <img alt="CI Status" src="https://img.shields.io/github/actions/workflow/status/shaankhosla/repeat/ci.yaml?branch=main&label=CI&logo=github" />
   </a>
+  <a href="https://shaankhosla.github.io/repeat/">
+    <img alt="Documentation" src="https://img.shields.io/badge/docs-GitHub%20Pages-blue?logo=github" />
+  </a>
   <a href="https://github.com/shaankhosla/repeat/releases">
     <img alt="Latest Release" src="https://img.shields.io/github/v/release/shaankhosla/repeat?display_name=tag&sort=semver&logo=github" />
   </a>
@@ -25,8 +28,14 @@
 - Progress is tracked with a hash of the card content, so edits automatically reset their progress.
 - Free Spaced Repetition Scheduler (FSRS), a state-of-the-art algorithm targeting 90% recall, automatically schedules reviews for you.
 - Terminal UX: `repeat drill` renders cards with ratatui; `repeat create` launches an editor dedicated to card capture; `repeat check` displays progress at a glance.
+- Inline media support: reference local images/audio/video inside your decks and open them from a drill session without leaving the terminal.
 - Import from Anki: convert `.apkg` exports into Markdown decks with `repeat import` so you can bring your existing collection along.
 
+
+## Documentation
+
+Installation, quick-start, and usage guides now live in the [documentation](https://shaankhosla.github.io/repeat/). 
+
 ## Installation
 
 ### Install script (Linux & macOS) - Recommended
@@ -73,8 +82,6 @@ npm install @shaankhosla/repeat
    C: Speech is [produced] in [Broca's] area.
    ```
 
-Alternatively, use the built-in editor with `repeat create cards/neuro.md`.
-
 
 2. Index the cards and start a session:
 
@@ -83,126 +90,8 @@ Alternatively, use the built-in editor with `repeat create cards/neuro.md`.
    ```
 
    - `Space`/`Enter`: reveal the answer or cloze.
+   - `O`: open the first media file (image/audio/video) referenced in the current card before revealing the answer.
    - `1`: mark as `Fail`, `2`: mark as `Pass`.
    - `Esc` or `Ctrl+C`: end the session early (progress so far is saved).
 
-3. Check your collection status:
-
-   ```
-   repeat check cards
-   ```
-
-   The command prints totals for new/reviewed cards, due/overdue counts, and upcoming workload.
-
-## Card Format
-Files can be structured in any way, such as:
-
-```
-flashcards/
-  math.md
-  science/
-      physics.md
-      chemistry.md
-      ...
-```
-
-Cards live in ordinary Markdown. `repeat` scans for tagged sections and turns them into flashcards. This means that you can embed your active recall content alongside your regular notes using your favorite markdown editor, such as Obsidian. Also, you can leverage all of the normal advantages of using markdown files, such as using version control to back them up.
-
-- **Basic cards**
-
-  ```
-  Q: What is Coulomb's constant?
-  A: The proportionality constant of the electric force.
-  ```
-
-- **Cloze cards**
-
-  ```
-  C: The [order] of a group is [the cardinality of its underlying set].
-  ```
-
-
-### Parsing Logic
-
-- Cards are detected by the presence of a `Q:/A:` or `C:` block. The end of the card is indicated by a horizontal rule (`---`), or the start of another card.
-- Cards are hashed with Blake3; modifying the text produces a new hash and resets that card's performance history.
-- Metadata lives in `cards.db` under your OS data directory (for example, `~/Library/Application Support/repeat/cards.db` on macOS). Delete the file to discard history; the Markdown decks remain untouched.
-- Multi-line content is supported.
-
-## Commands
-
-### `repeat drill [PATH ...]`
-
-Start a terminal drilling session for one or more files/directories (default: current directory). Options:
-
-- `--card-limit <N>`: cap the number of cards reviewed this session.
-- `--new-card-limit <N>`: cap the number of unseen cards introduced.
-
-Example: drill all the physics decks and a single chemistry deck, and stop after 20 cards.
-
-```
-repeat drill flashcards/science/physics/ flashcards/science/chemistry.md --card-limit 20
-```
-
-### `repeat create <path/to/deck.md>`
-
-Launch the capture editor for a specific Markdown file (it is created if missing). Shortcuts:
-
-- `Ctrl+B`: start a basic (`Q:/A:`) template.
-- `Ctrl+K`: start a cloze (`C:`) template.
-- `Ctrl+S`: save the current card (hash collisions are rejected).
-- Arrow keys/PageUp/PageDown: move the cursor; `Tab`, `Enter`, `Backspace`, and `Delete` work as expected.
-- `Esc` or `Ctrl+C`: exit the editor.
-
-Example: open (or create) the neuro deck for editing.
-
-```
-repeat create cards/neuro.md
-```
-
-### `repeat check [PATH ...]`
-
-Re-index the referenced decks and emit counts for total, new, due, overdue, and upcoming cards so you can gauge the workload before drilling.
-
-Example: review stats for math class `flashcards/math/` before a study session.
-
-```
-repeat check flashcards/math/
-```
-
-### `repeat import <anki.apkg> <output-dir>`
-
-Convert an Anki `.apkg` export into Markdown decks. If files with the same names already exist in the export folder, they will be overwritten, so this command is safe to rerun if needed. This is a beta feature, so please report any issues on GitHub. FSRS history is not currently transferred over.
-
-Example: import `my_collection.apkg` into `cards/anki/` and start drilling right away.
-
-```
-repeat import ~/Downloads/my_collection.apkg cards/anki
-```
-
-
-## Development
-
-Run the lint/test suite with:
-
-```
-cargo fmt --all
-cargo clippy
-cargo test
-```
-
-The repository also ships a `just precommit` recipe that runs the same checks.
-
-
-## Roadmap
-
-- [X] Import from Anki
-- [ ] Allow scrolling to other cards in a collection while creating a new card
-- [ ] Edit an existing card while keeping the progress intact
-- [ ] Allow for a fuzzy search of existing cards
-- [ ] Use LLMs to import from various content sources
-
-
-## License
 
-Licensed under the Apache License, Version 2.0. See `LICENSE` for details.

package/npm-shrinkwrap.json

@@ -22,7 +22,7 @@
       },
       "hasInstallScript": true,
       "name": "@shaankhosla/repeat",
-      "version": "0.0.22"
+      "version": "0.0.24"
     },
     "node_modules/@isaacs/balanced-match": {
       "engines": {
@@ -514,5 +514,5 @@
     }
   },
   "requires": true,
-  "version": "0.0.22"
+  "version": "0.0.24"
 }

package/package.json

@@ -1,5 +1,5 @@
 {
-  "artifactDownloadUrl": "https://github.com/shaankhosla/repeat/releases/download/v0.0.22",
+  "artifactDownloadUrl": "https://github.com/shaankhosla/repeat/releases/download/v0.0.24",
   "author": "shaankhosla",
   "bin": {
     "repeat": "run-repeat.js"
@@ -83,7 +83,7 @@
       "zipExt": ".tar.xz"
     }
   },
-  "version": "0.0.22",
+  "version": "0.0.24",
   "volta": {
     "node": "18.14.1",
     "npm": "9.5.0"