Skip to content

FlorianWoelki/obsidian-better-recall

Repository files navigation

Obsidian Better Recall

Preview Image

What is it?

WIP

Things to do before release:

  • Add Anki algorithm
  • Add functionality of creating and recalling custom decks
  • Add cards via Add Card Modal
  • Add recall view
    • Add empty view
    • Add view for selecting decks
    • Add view for managing decks
      • Add deletion of cards
    • Add view for recalling notes
    • Use Anki algorithm to recall notes
  • Add create modal for creating decks
  • Add ribbon icon which opens the recall view
  • Add data integration
  • Add settings view for customizing Anki algorithm parameters
  • Test and adapt to mobile experience

Use the plugin before the release?

I am still actively developing this plugin, but I have not yet submitted it to Obsidian. However, you can still use the plugin using BRAT:

  1. Open Obsidian and go to the community plugins tab.
  2. Search for BRAT and install it.
  3. Click on the Add Beta Plugin button.
  4. Paste the plugin link: https://github.com/FlorianWoelki/obsidian-better-recall
  5. Click Add Plugin.

Disclaimer: Things can break while in active development. Feel free to report any issues or bugs.

Development

To customize this project for your needs, you can clone it and then install all dependencies:

$ git clone https://github.com/FlorianWoelki/obsidian-better-recall
$ cd obsidian-better-recall
$ yarn

After the installation, you need to create a env.mjs file in the root directory. Fill the file with the following content:

export const obsidianExportPath =
  '<path-to-obsidian-vault>/.obsidian/plugins/obsidian-better-recall';

Afterward, you can start the rollup dev server by using:

$ pnpm dev

This command will automatically build the necessary files for testing and developing every change. Furthermore, it copies all the essential files to the specified plugin directory.

Finally, you can customize the plugin and add it to your plugins.