note2cal.nvim

note2cal is a Neovim plugin designed to quickly create events directly from markdown files. Making for a great companion to whatever note taking flow you use.

With one keymap (or one command), a line like Do something @ 3pm-4pm or Do something @ 2025-01-20 3pm-4pm will be converted to an accordingly named event in your calendar at that specified time. See more ways to specifying the time in the Supported Formats section.

Two calendar providers are supported: "macos-calendar" (default, requires macOS + Calendar.app via AppleScript) and "google" (cross-platform, talks directly to the Google Calendar API — see Google Calendar setup below)

Limitations

Contributions are welcome!

• There's a wide range of supported time formats (see below), but for now the only supported date format is YYYY-MM-DD
• No support for multi-day events yet
• Works in Markdown files only for now

Supported Formats

We support various time formats, including 24-hour, AM/PM, military time, and compact formats. The following table summarizes it, you can also see the spec for more examples:

Installation and configuration

Example using Lazy (the values listed are the default ones):

{
  'lfilho/note2cal.nvim',
  config = function()
    require("note2cal").setup({
      debug = false, -- if true, prints a debug message and return early (won't schedule events)
      provider = "macos-calendar", -- "macos-calendar" (default) or "google"
      macos = { -- only needed if using macos Calendar.app
        calendar_name = "Work", -- the calendar's name as it appears in Calendar.app
      },
      google = { -- only needed if using google calendar
        -- see the "Google Calendar setup" doc for oauth details
        calendar_id = "primary", -- "primary" for your default calendar, or a specific calendar's ID
        security = "os-key-store", -- "os-key-store" (default) or "plain-file (not recommended)"
      },
      highlights = {
        at_symbol = "WarningMsg", -- the highlight group for the "@" symbol
        at_text = "Number", -- the highlight group for the date-time part
      },
      keymaps = {
          normal = "<Leader>se", -- mnemonic: Schedule Event
          visual = "<Leader>se", -- mnemonic: Schedule Event
      },
    })
  end,
  ft = "markdown",
},

Usage

It works in normal mode and visual mode (single or multiple lines). Just call it with the keymap you configured above or invoke the command :Note2cal in the desired lines.

[!NOTE]

• If no date is provided, the script assumes today's date.

Google Calendar setup

See here.

Contributing

Contributions are welcome!

• Make sure to have lua@5.1, luarocks and busted installed (e.g.: brew install lua@5.1 luarocks && luarocks --lua-version=5.1 install busted luafilesystem) — pinned to 5.1 since that's what scripts/test.sh targets (matches the Lua semantics Neovim itself runs under, and avoids Homebrew's unversioned lua formula drifting out from under busted)
• Run tests with ./scripts/test.sh

Ideas / TODOs

• Make the current @ pattern configurable
• Compile the applescript for slightly better performance
• Add a conceal / virtual icon to denote the event was scheduled
• Add support for other file types other than markdown
• Add support for other date formats other than YYYY-MM-DD
• Run tests on Github on push to main
• Add icon to sign column to indicate there's an event in that line
• Support natural language (@ tomorrow, @ next tuesday, etc). Thanks u/my_mix_still_sucks on reddit for the suggestion

Similar plugins

None that I know of, feel free to send me a PR to list it here!

• https://github.com/itchyny/calendar.vim → ❌ It brings a read-only calendar view to inside vim, not what we do

Related plugins

This plugin would be a great addition to note taking or task management plugins, such as:

• https://github.com/atiladefreitas/dooing
• https://github.com/zk-org/zk-nvim
• https://github.com/vimwiki/vimwiki
• and probably many others :)