roam-memo
roam-memo copied to clipboard
Remember everything with this spaced repetition plugin for Roam!
Memo - Spaced Repetition for Roam
Memorize anything with this simple spaced repetition plugin for Roam. Similar to Anki, it uses a modified version of the SuperMemo 2 (SM2) Algorithm under the hood.
What is "Spaced Repetition"
Spaced repetition is a technique for studying where you review flashcards based on how well you remember them. Instead of reviewing every card in order, you review cards that were harder to remember more often, and cards that were easier to remember less often. This helps you review the cards that you need to work on more, and avoid wasting time reviewing cards that you already know well.
This plugin allows you to tag important information with a special tag, and over time it will help you move the information from short term memory to long term memory.
Installation
Just install through Roam Depot, then go to settings and configure the page tags you want to use for reviews (default is #memo
) and that's it. Enjoy.
Usage
To use the Memo plugin for studying flashcards:
- Create a new page and add the #memo tag to it.
- Open the plugin from the side panel.
- Begin reviewing the flashcards.
If the block nested blocks they will be treated as answers and initially hidden. Click the "Show Answer" button to reveal them.
Features
Multi Tag Support (aka decks)
To create separate decs just got to our plugin settings page, find the "Tag Pages" field and add a comma separated list of all the pages you want to use as decks. For example, if you want to create a deck for "Spanish" and another for "French" you would add Spanish, French
to the field.
To use tags that have commas in them just wrap them in quotes. For example, "Page, with Comma".
Text Masking
Text Masking or Cloze Deletion is a technique where you hide or mask a part of the text to test your understanding or to make it harder to memorize. To mask a part of text, you can use two different methods:
- Highlighting the text and adding ^^ on both sides of the text you want to mask. Example: ^^hide me^^
- Wrapping the text with single brackets { }. Example: {hide me too}.
Daily Limits
You can set a daily limit for the number of cards you want to review. This is useful if you want to limit the time you spend reviewing cards. We ensure at least ~25% of cards are new cards.
You can set the daily limit in the plugin settings page.
Cram Mode
When you're done reviewing all due cards in a deck you can choose to continue in "Cram Mode". This will let you review all the cards in the deck regardless of when they are due. This is useful if you're studying for an exam and can't wait for the cards to become due. Reviewing cards in this mode do not affect spaced reptition scheduling.
Keyboard Shortcuts
Action | Shortcut |
---|---|
Show answer | space |
Skip a card | s or → |
Go back | ← |
Show breadcrumbs | b |
Grade: perfect | space |
Grade: forgot it | f |
Grade: If it was hard | h |
Grade: If it was good | g |
Command Palette Action
You can start a review session from the command palette (CMD + P
) by typing "Memo: Start Review Session".
RoamSr Migration Tool
To migrate your data from the old RoamSr plugin follow these steps:
Note: To be extra safe, I recommend you make a backup of your #roam/memo page before migrating.
- Generate an API key with write access by following these instructions here.
- Go to the settings page of the plugin and click on the "Launch" button under the "Migrate Roam/Sr Data" section.
- Enter API key and press "Fetch Preview Data"
- Review the data. All your old roam/sr data should be displayed in the table. New records should be merged with old ones.
- If everything looks good, press "Import"
If you have a lot of data, it might take a while to sync. So go grab coffee.
Bug Reports and Feature Requests
Please just create issues here and I'll get to them as soon as I can.
I build this primarily because I wanted it to exist but it brings me great joy to see so many of you finding it useful too 🤓🥰