/obsidian-countdown

Creates a countdown timer to an event Obsidian.md

Primary LanguageTypeScriptMIT LicenseMIT

Obsidian Countdown Timer Plugin

This plugin for Obsidian (https://obsidian.md) allows you to create a countdown timer inside your markdown notes. The timer will display the remaining time until a specified event, including days, hours, minutes, and seconds.

Features

  • Display countdown timer in markdown notes
  • Customizable event name
  • Customizable date format (supports both 24-hour and 12-hour format)
  • Error message for invalid date format

Installation

  1. Download the latest release of the plugin.
  2. Open Obsidian.
  3. Go to "Settings" -> "Community Plugins"
  4. On the same line as "Installed plugins", click the folder icon.
  5. Extract the downloaded zip file's contents directly into the plugins folder. You should now have a folder named obsidian-countdown inside your plugins folder.
  6. Enable the plugin

Usage

To insert a countdown timer, add a code block to your note with the language set to countdown, followed by the event name and target date on separate lines.

Example:

```countdown
My Special Event
2024-12-31 23:59
```

The countdown timer will appear in the preview mode of the markdown note.

Settings

In the plugin settings, you can customize the date format used for parsing the target date. The default format is "YYYY-MM-DD HH:mm", but you can change it according to your preference. The plugin uses Moment.js (https://momentjs.com/docs/#/parsing/string-format/) for date parsing, so refer to its documentation for supported formats.

License

This plugin is released under the MIT License. For more information, please see the LICENSE file in the repository.

Contributing

Contributions, bug reports, and feature requests are welcome. Please submit a pull request or create an issue on the repository's GitHub page.