Skip to content

Latest commit

 

History

History
33 lines (17 loc) · 3.92 KB

README.md

File metadata and controls

33 lines (17 loc) · 3.92 KB

Spaced Everything (Obsidian plugin)

Obsidian plugin to apply spaced repetition algorithms to everything in your vault.

Borrowing from Andy Matuschak's notes outlining such a practice, this plugin applies the main concepts of spaced repetition to writing. That is, using the SuperMemo-2.0 algorithm to decide what note to review next when engaging in a Spaced Writing Practice (SWP).

(still under development): The plugin is extensible. It allows each note to be tagged to different contexts (e.g., work vs personal) to only pull up notes approriate for the moment. Each context may optionally apply different spacing algorithms. This includes fully customized JavaScript implementations to derive your own spacing algorithms, in addition to built-in implementations.

Features

Review a note

Taking from Andy's proposed idea, when reviewing a note you can select among three options for how the review went: Fruitful, Unfruitful, or Ignore. Fruitful means you made good progress on the note; this guides the spacing algorithm to include the note again soon in your queue. Unfruitful means you tried to engage with the note but progress was limited; this pushes that note out further in your queue. Ignore is an in-between option.

You may customize these options for this review process. You may add or delete options and change their numeric value. Currently, the only spacing algorithm implemented is the SuperMemo-2.0 algorithm. The numeric value provided in the settings alongside each review option maps to the "review quality score" from that algorithm. Over time, I may experiment with adding alternate spacing algorithms and further customizations.

Pull up next note in review queue

At any time, you may run the "Open next review note" command to pull up the next note in your review queue. This is calculated based on looking across the SWP frontmatter properties of notes in your vault. From there, it adds the interval value (in days) to the last review timestamp to derive the due date for each note. Then any notes with a due date in the future are filtered out. Among remaining notes, it sorts it by the earliest/oldest due date timestamp first and pulls notes in that order.

Toggle note contexts

By default, all notes are treated as one large queue of notes to review. However, you may optionally add any number of separate contexts to filter down which subset of notes to include when pulling up the next note in the review queue. When onboarding notes, it will prompt you to select which SWP context to add the note into. You may also run the "Toggle note contexts" command on any note to add/remove the note from any context.

You can create and remove SWP contexts from within the settings. You may also toggle which contexts are "active" (i.e., only notes matching an active context are considered when going through the review queue).

Onboard individual notes

Only notes you actively choose to review to onboard are considered for the spaced writing practice review queue. When running the "Log review outcome" command on a note not yet onboarded, it will onboard the note. When conducting the review (using that same command), you may remove any individual note at any time.

Logging

The actions you take in this spaced writing practice can optionally be logged to a local file. This data is stored in JSONL format. Some customization is possible in the settings, including providing a list of frontmatter properties that you are interested in capturing for whichever note the action was taken on.