mdremind
mdremind is a simple reminder tool that watches your notes directory for markdown files containing reminder entries and sends notifications based on their due dates.
Installation
go install github.com/AyushRawal/mdremind
Usage
- Ensure your reminder entries in Markdown files follow the following format (dataview inline metadata format):
- [ ] <title> [due:: <datetime>]
-
And, the datetime is in the format: 2023-03-15T13:04
-
Add the configuration file.
On Linux, it looks for the configration file at $XDG_CONFIG_HOME/mdremind.jsonc
if $XDG_CONFIG_HOME
is set, else $HOME/.config/mdremind.jsonc
. On Windows, it looks for %AppData%\mdremind.jsonc
.
-
Run mdremind.
Configuration
Sample configuration (for linux based OS):
// mdremind.jsonc
{
"notes_directory_path": "${HOME}/Notes",
"default_reminder_time": "09:00", // 24 hour format
"notification_cmd": "notify-send",
"notification_cmd_arguments": [
"-i",
"calendar",
"Reminder"
],
// "timezone": "", // optional, uses system's timezone by default (except for android, see: `https://github.com/golang/go/issues/20455`)
"ignored_directories": [ // optional
".git",
".obsidian",
".trash",
"templates",
".stfolder",
"Excalidraw",
"assets"
]
}
Contributing
Contributions are welcome! If you have any ideas for improvements, feature requests, or bug reports, please open an issue or submit a pull request.
License
This project is licensed under the MIT License.