README file from
Githubharang-calendar
🌐 English | 한국어
📖 Documentation (English / 한국어)
An Obsidian plugin that lets you view events from a CalDAV calendar directly from your notes. The plugin is read-only — it never creates, edits, or deletes anything on your CalDAV server.
Features
{{hrcal:staged autocomplete — type{{hrcal:and pick an account, then a calendar, then either a date or an event title from one combined list. It inserts{{hrcal:<accountId>:<calendarName>:date:yyyy-mm-dd}}(renders as a widget listing that day's events as cards) or{{hrcal:<accountId>:<calendarName>:event:<uid>}}(renders as an inline chip). Click a chip (or a card in a date widget) to see the full detail popup. You still search by the account's readable name when picking it in the popup —<accountId>is the account's internal id, inserted for you automatically, never typed by hand. Because it's an id rather than a name, renaming an account afterward no longer breaks references you've already inserted;<calendarName>is still the calendar's display name, so renaming a calendar can still break existing references, same as before.- Calendar view — an agenda list of upcoming events in the sidebar, and a full month grid (with navigation, and click-a-day to see its events) in a workspace tab, both built with Vue 3.
- Multiple CalDAV servers and calendars — configure any number of server accounts; each account is tested and its calendars discovered and individually enabled/colored from Settings.
- Configurable time zone — pick your calendar's IANA time zone or a manual UTC offset per account, used to resolve event times that aren't already UTC.
- Recurring events —
RRULE/EXDATEare expanded into their actual occurrences within whatever range is being viewed. - Follows Obsidian's UI language — Korean or English depending on your Obsidian language setting (via the official
getLanguage()API). - Stale-reference warnings — a date widget warns if the account or calendar referenced by its
{{hrcal:...}}reference no longer matches one you have configured (e.g. after a calendar rename, or an account that no longer exists).
Prerequisites
- A CalDAV-compatible calendar reachable over HTTP(S) with Basic Auth — e.g. Radicale, Nextcloud Calendar, Fastmail, or any RFC 4791 server.
- Obsidian 1.13.4 or later.
Installation
Open Settings → Community plugins → Browse, search for Harang Calendar, then click Install and Enable.
Prefer installing pre-built files manually instead? See the Installation guide in the documentation for that and other options.
Usage
- Open Settings → Harang Calendar and click Add CalDAV server to configure an account, then Test connection & discover to find its calendars.
- In any note, type
{{hrcal:and pick an account, then a calendar, then a date or an event to insert a reference. - Browse events any time with the Open calendar in sidebar or Open calendar in a new tab commands.
See the Usage guide for full details.
License
BSD-3-Clause — see LICENSE.