# Obsidian Upcoming Birthdays

A plugin for Obsidian that tracks and displays upcoming birthdays from your notes.

## Features

- 📅 Finds notes with a `date-of-birth` property in a folder you choose
- 🎂 Shows upcoming birthdays with age calculation
- 🎉 Highlights birthdays happening today or soon
- ⚙️ Customizable settings for property name and look-ahead period
- 📍 Click on names to open the corresponding note

## Usage

### Choose a Birthday Notes Folder

In the plugin settings, set **Birthday notes folder** to the folder containing your birthday notes, for example `People`.

The plugin scans only that folder and its subfolders. Leave the setting empty to disable scanning, or set it to `/` if you explicitly want to scan the whole vault.

### Adding Birthdays to Your Notes

Add a `date-of-birth` property to the frontmatter of a note in that folder:

```markdown
---
date-of-birth: 1990-05-15
---

# John Doe

Contact information and other details...
```

### Viewing Birthdays

Use the command palette (Ctrl/Cmd + P) and search for "Open Birthday View"

The birthday view will appear in the right sidebar showing:
- Birthdays happening today (highlighted)
- Upcoming birthdays within your configured range
- How many days until each birthday
- The age the person will turn

## Settings

- **Date of Birth Property**: The frontmatter property name to look for (default: `date-of-birth`)
- **Birthday Notes Folder**: The folder to scan for birthday notes. Empty disables scanning; `/` scans the whole vault.
- **Days to Look Ahead**: How many days in advance to show birthdays (default: 30)

## Installation

### For Development

1. Clone this repository into your vault's `.obsidian/plugins/` folder:
   ```bash
   cd /path/to/vault/.obsidian/plugins
   git clone https://github.com/nithinbekal/obsidian-upcoming-birthdays.git
   ```

2. Install dependencies:
   ```bash
   cd obsidian-upcoming-birthdays
   npm install
   ```

3. Build the plugin:
   ```bash
   npm run build
   ```

4. Reload Obsidian and enable the plugin in Settings → Community Plugins

### For Development with Auto-Reload

Run in development mode with auto-rebuild:
```bash
npm run dev
```

## Date Formats

The plugin accepts any standard date format that JavaScript can parse:
- `1990-05-15` (ISO format, recommended)
- `1990/05/15`
- `May 15, 1990`
- `15 May 1990`

## License

MIT