org.nvim feature examples

Each file in this directory covers one feature area of org.nvim in depth. They are meant to be worked through, not just read: every section explains a feature, shows several examples, and ends with exercises.

• Lines starting with Try: are exercises, with the exact keys to press.
• Lines starting with Expect: say what you should see afterwards, so you can check that the feature works.
• Lines starting with # are Org comments that annotate the example next to them. They are dimmed, and they are never exported.
• Keys use <prefix> for the org.nvim prefix, <leader>o by default. Press g? in any org buffer to list the keys of that buffer.
• Nothing breaks if you make a mess: u undoes, and git checkout examples/ restores every file.

Start Neovim from the repository root with the bundled init file, so the examples use a known configuration and your own notes are never touched:

nvim -u examples/minimal_init.lua examples/00-index.org

It points agenda_files at the files of this directory and sends captures to a scratch directory under stdpath("state"). Put the cursor on a link below and press <CR> to open that file. <C-o> brings you back here.

The examples use dates around late September 2026. When they are in the past, press <C-a> on the day of a timestamp to move it forward.

If you would rather take a quick tour of everything in one file first, start with tutorial.org.