luiisca / obsidian-periodic-notes-calendar

Obsidian calendar plugin for writing and organizing periodic notes (daily to yearly). Navigate via command palette or calendar UI. Summarize entries with stickers in calendar view. Streamline planning, reviewing, and reflection.
MIT License
1 stars 0 forks source link
calendar obsidian-plugin svelte

πŸ“… Obsidian Periodic Notes Calendar Plugin

Obsidian calendar plugin for writing and organizing periodic notes (daily to yearly). Navigate via command palette or calendar UI. Summarize entries with stickers in calendar view. Streamline planning, reviewing, and reflection.

screenshot-full

Features

Usage

Command Palette

Access the Command Palette (Cmd/Ctrl + P) and type Periodic Notes Calendar:

Command Palette Demo

Calendar UI

  1. Click the calendar icon in the ribbon or use the command Periodic Notes Calendar: Open Calendar
  2. Select a date to create or open a note for that day

Calendar UI Demo

Natural Language Date Creation

You can create notes for specific dates using natural language:

  1. Open the Command Palette
  2. Type Periodic Notes Calendar: NLDates
  3. Enter a phrase like "two months from now" or "next Tuesday"
  4. The plugin will create a note for the specified date

NL date creation demo

Emoji Summaries

Emoji summaries allow you to add visual "stickers" to your notes on the calendar, providing a quick overview of your entries. There are two ways to add emoji summaries:

  1. From the editor:

    • Type #emoji-<your-emoji> anywhere in your note (e.g., #emoji-πŸŽ‰)
    • The plugin will automatically extract the emoji and display it as a sticker on the corresponding date in the calendar view

demo

  1. From the calendar:

    • Right-click on any date in the calendar view
    • Select "Add emoji"
    • Choose an emoji from the picker
    • The selected emoji will be added as a sticker for that date on the calendar

demo

These emoji stickers appear on top of the note icon in the calendar, allowing you to quickly visualize the content or mood of your entries without opening them.

Customization

Override these CSS variables in your obsidian.css file for further customization:

body {
  --calendar-bg: var(--background-secondary);
  --calendar-border: var(--background-modifier-border);
  --calendar-color: var(--text-normal);
  --calendar-heading-color: var(--text-muted);
  --calendar-selected-bg: var(--interactive-accent);
  --calendar-selected-color: var(--text-on-accent);
  --calendar-today-bg: var(--interactive-accent-hover);
  --calendar-hover-bg: var(--background-modifier-hover);
}

Installation

  1. Open Obsidian and go to Settings > Community Plugins
  2. Disable Safe Mode
  3. Click "Browse" and search for "Periodic Notes Calendar"
  4. Click "Install", then "Enable" to activate the plugin

Configuration

Go to Settings > Community Plugins > Periodic Notes Calendar to customize:

Settings Demo

Tips and Tricks

Customizable Emoji Summaries

You can use emojis to provide a quick visual summary of your notes. The plugin allows you to choose any emoji from the emoji picker dialog. Here are some examples of how you might use them:

😊 : A positive day πŸ“ : Significant writing done πŸ† : Achieved a goal 🌟 : Important day πŸŽ‰ : Celebration or special event

Feel free to create your own emoji system that works best for your needs!

Natural Language Date Navigation

In addition to creating notes, you can also use natural language to navigate to specific dates. Try commands like:

This feature makes it easy to quickly access notes without needing to know the exact date.

Open notes in a new pane

Ctrl/Cmd + Click on a date to open that note in a new pane.

Reveal open note on calendar

If you open a note from a different month, you might want to see it on the calendar view. To do so, you can run the command Periodic Notes Calendar: Reveal open note from the command palette.

FAQ

How do I change the styling of the Calendar?

By default, the calendar should seamlessly match your theme, but if you'd like to further customize it, you can! In your obsidian.css file (inside your vault) you can configure the styling to your heart's content.

I accidentally closed the calendar. How do I reopen it?

If you close the calendar widget (right-clicking on the panel nav and clicking close), you can always reopen the view from the Command Palette. Just search for Calendar: Open view.

How do I change the calendar start day?

You can set the start day of the week in the plugin settings.

Can I use this plugin on mobile?

Yes! The Periodic Notes Calendar plugin is fully compatible with Obsidian Mobile.

Support

If you encounter any issues or have feature requests, please file them in the GitHub Issues section.

Say Thanks πŸ™

If you find this plugin helpful, consider supporting its development:

ko-fi