Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
jamesb committed May 3, 2021
2 parents 188b6d8 + e538525 commit 2a84830
Showing 1 changed file with 22 additions and 9 deletions.
31 changes: 22 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,24 @@
# Obsidian Incremental Writing Plugin

This plugin allows you to do incremental writing in Obsidian. Notes and blocks can be added to queues that will schedule reviews of your writing over time.
This plugin allows you to do [incremental writing](https://supermemo.guru/wiki/Incremental_writing) in Obsidian. In incremental writing you add notes and blocks to prioritised queues to be reviewed incrementally over time.

I made a video explaining incremental writing using an earlier version of the plugin [here](https://youtu.be/LLS_8Y744lk). I will create an updated version soon!
To learn more about the ideas behind incremental writing, check out [this video I made](https://youtu.be/LLS_8Y744lk).

### Notes
To see the Obsidian incremental writing plugin in action, check out the [getting started video](https://youtu.be/bFF3umvXydQ).

- This plugin adds a button to the search pane using private Obsidian APIs which could cause the plugin to break when Obsidian updates until I have time to fix it.
- If you are using Vim mode, adding a block to the queue must be done with a hotkey because using ctrl+p to open the command palette causes the cursor to move up a line, so the wrong block will get added.
### Support

I want to put all of my energy into these projects and work on them full time! I also want to keep as much of my content open source and freely available as possible. That those seeking knowledge may find it!

If you would like to support my work, I have a [Patreon page](https://www.patreon.com/experimental_learning) with rewards for each tier or you can [buy me a coffee](https://www.buymeacoffee.com/experilearning).

## Using the plugin

If you have installed the nldates plugin, you can use natural language when you are asked to provide a date eg. "tomorrow" or "in two weeks".
### Notes

- This plugin adds a button to the search pane using private Obsidian APIs which could cause the plugin to break when Obsidian updates until I have time to fix it.
- If you are using Vim mode, adding a block to the queue must be done with a hotkey because using ctrl+p to open the command palette causes the cursor to move up a line, so the wrong block will get added.
- If you have installed the nldates plugin, you can use natural language when you are asked to provide a date eg. "tomorrow" or "in two weeks".

There are currently 10 hotkey / command palette commands and a couple of buttons and context menu commands.

@@ -30,8 +37,14 @@ You can also add the output from an inbuilt search to a queue. Do a search and c

You can also right click on folders, files and links to add them to queues through the context menu.

## Support
## Scheduling Options

I want to put all of my energy into these projects and work on them full time! I also want to keep as much of my content open source and freely available as possible. That those seeking knowledge may find it!
There are currently two scheduling styles to choose from: A-Factor and Simple.

If you would like to support my work, I have a [Patreon page](https://www.patreon.com/experimental_learning) with rewards for each tier or you can [buy me a coffee](https://www.buymeacoffee.com/experilearning).
### Simple

When you hit next repetition, the current repetition gets pushed to the end of the queue.

### A-Factor

When you hit next repetition, the interval between repetitions gets multiplied by the A-Factor to work out the next repetition date.

0 comments on commit 2a84830

Please sign in to comment.