https://github.com/ryanjamurphy/review-obsidian

Add the current note to a future daily note to remember to review it.
https://github.com/ryanjamurphy/review-obsidian

obsidian-md obsidian-plugin

Last synced: 4 days ago
JSON representation

Add the current note to a future daily note to remember to review it.

• Host: GitHub
• URL: https://github.com/ryanjamurphy/review-obsidian
• Owner: ryanjamurphy
• Created: 2020-11-04T21:15:46.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-11-03T17:02:04.000Z (about 1 year ago)
• Last Synced: 2024-08-02T14:12:56.656Z (3 months ago)
• Topics: obsidian-md, obsidian-plugin
• Language: TypeScript
• Homepage:
• Size: 23.4 KB
• Stars: 132
• Watchers: 3
• Forks: 8
• Open Issues: 15
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-starred-test - ryanjamurphy/review-obsidian - Add the current note to a future daily note to remember to review it. (TypeScript)
• jimsghstars - ryanjamurphy/review-obsidian - Add the current note to a future daily note to remember to review it. (TypeScript)

README

        
## Review

A plugin for [Obsidian](https://obsidian.md).

Review allows you to add the current note to a future note (or past note, if you want to, I guess) to make sure you review it again on that date.

This can be useful for project review (e.g., Getting Things Done), as a tickler file (e.g., Getting Things Done, again), spaced repetition, and to remind you of past failures or that embarrassing thing you did yesterday. 

Review integrates with (and therefore requires) the [Natural Language Dates plugin](https://github.com/argenos/nldates-obsidian). Please install it first.

### Setup

Make sure you _review_ (heh) the plugin's settings to assign:

- A heading for the review section (defaults to `## Review`).

- A prefix for each line added when you invoke Review (e.g., 

- A prefix for each block added when you invoke Review on a block (e.g., using `!` will make each block an embed automatically)

- A default for each review (e.g., if you use `tomorrow`, you can just hit enter when you invoke Review to put the thing you're reviewing on tomorrow's daily note

### How to use

- Use the command palette to access the Review command (or assign a hotkey to it).

- Once you invoke the command palette, the plugin asks for a date. Use natural language ("tomorrow," "in three weeks," "two days ago," "November 5")

- The plugin relies on the Natural Language Dates plugin to translate your given date into a daily note name as per your settings in that plugin

- The plugin then creates a new daily note for the given day with a new review section (or appends this section to the given daily note, if one already existed).

### Demo

![A gif showing the use of this plugin as described above.](https://i.imgur.com/9AqrSKy.gif)

### Manually installing the plugin

- Copy `main.js` and `manifest.json` to your vault's plugins folder, under `[YourVaultFolder]/.obsidian/plugins/review-obsidian/`.