Weekly Heatmap for Obsidian

A simple Obsidian plugin that displays a 52-week heatmap calendar. Click on any week to open (or create) a corresponding weekly note.

Features

• 📅 52-Week Heatmap View - Visual overview of your entire year
• 🎨 Visual Distinction - Past/current weeks are highlighted differently from future weeks
• 📝 Quick Weekly Notes - Click any week to open or create a weekly note
• 🏷️ Smart Naming - Notes are automatically titled with format: Week [number]: [Start] - [End]
• ⚙️ Customizable Settings - Configure folder path, note template, and week start day

Settings

Access settings via Settings → Community Plugins → Weekly Heatmap

Setting	Description	Default
Weekly Notes Folder	Folder where notes are created	Weekly Notes
Week Start Day	Monday or Sunday	Monday
Note Template	Custom markdown template for new notes	Tasks & Notes sections

Installation

Option 1: Download from Releases (Recommended)

1. Download the latest release from the Releases page
2. Extract the downloaded files
3. Copy the files into your vault's plugins folder: <vault>/.obsidian/plugins/weekly-heatmap/
4. Make sure these files are in the folder:
   • main.js
   • manifest.json
   • styles.css
5. Reload Obsidian
6. Enable the plugin in Settings → Community Plugins

Option 2: Manual Installation (For Developers)

1. Clone this repository into your vault's plugins folder:

   cd <vault>/.obsidian/plugins/
   git clone https://github.com/aj-abhinai/weekly-heatmap.git
   cd weekly-heatmap
   

2. Install dependencies:

   npm install
   

3. Build the plugin:

   npm run build
   

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

Usage

1. Click the calendar icon in the ribbon or use the command palette to open "Weekly Heatmap"
2. View the 52-week heatmap in the sidebar
3. Click on any week to open or create a weekly note
4. Weekly notes are automatically created in the Weekly Notes folder

Development

• npm run dev - Start development build with watch mode
• npm run build - Create production build

License

MIT License - see LICENSE file for details

Support

If you find this plugin helpful, please consider:

• ⭐ Starring the repository
• 🐛 Reporting bugs or requesting features via Issues
• 🤝 Contributing via pull requests

---