Files
waypoint/README.md
T

3.5 KiB
Raw Permalink Blame History

Waypoint

Calendar, recent files, and custom bookmarks sidebar for Obsidian.

Features

  • Calendar panel — refined month grid; left-click a day opens its daily note, middle-click opens it in a tab, and right-click reveals every configured note system for that date
  • Calendar indicators — retain a single neutral note dot or show a coloured dot per daily, journal, meeting, or custom date system
  • Recent files — track recently opened/edited files
  • Favorites — custom bookmarks with groups, icons, and rename

Commands

Command Default Hotkey
Go to daily note Ctrl+Shift+Alt+D
Go to weekly note Ctrl+Shift+Alt+W
Go to monthly note Ctrl+Shift+Alt+M
Go to quarterly note Ctrl+Shift+Alt+Q
Go to yearly note Ctrl+Shift+Alt+Y
Next/Previous daily/weekly/monthly/quarterly/yearly note

Date systems

Right-click any calendar day to open its date systems menu. The daily note always appears first; left-click behaviour is unchanged. The included defaults match this vault's common layouts:

System Folder Name format Behaviour
Journal periodic/journal YYYY-MM-DD - [Journal] Opens or creates one journal note for the date
Meeting periodic/meetings YYYY-MM-DD - {title} Lists every meeting for the date and can create another

Configure systems in Settings → Waypoint Sidebar → Date systems. Each system has a folder, filename format, template, fallback frontmatter type, Lucide icon, and indicator colour. Template file fields autocomplete every Markdown path in the vault.

Name format uses moment.js tokens. Bracket-escape literal text: YYYY-MM-DD - [Journal]. Add {title} when a date can have multiple notes; it is replaced with the title requested when creating a note. Without {title}, the system has exactly one note per date.

Ctrl/Cmd-click a menu entry opens it in a new tab.

Calendar indicators

Under Settings → Waypoint Sidebar → Calendar, choose either:

  • Colour by note system — the default; one compact coloured dot per configured date system that has a note on that day. Hover a dot to identify its system.
  • Single dot — a neutral marker for any note whose filename is exactly the date.

Daily uses the Calendar tabs colour picker. Journal, Meeting, and every custom system have their own Indicator colour picker under Date systems. The defaults are blue for Daily, green for Journal, and violet for Meeting.

Templater folder templates

If a date system uses a Templater folder mapping, leave its Waypoint Template file field blank. Waypoint then creates a safe fallback note while Templater owns prompts, scripts, cursors, and rendered content.

The selected calendar date is encoded in the filename. Templater templates should derive their date from tp.file.title, not from tp.date or tp.file.creation_date(). A journal template can retain a prompt-and-rename fallback for manual note creation, but it must skip that flow when the filename already follows YYYY-MM-DD - Journal.

Installation

Via BRAT

  1. Install the BRAT plugin
  2. Add https://gitea.mithrilforge.dev/olivier/waypoint as a Beta Plugin
  3. Enable Waypoint in Community Plugins

Manual

  1. Download the latest release from Gitea
  2. Extract main.js, manifest.json, and styles.css to {vault}/.obsidian/plugins/waypoint/
  3. Enable Waypoint in Community Plugins