Enable and Verify Norg Checklist Items in nvim-orgmode
A task guide to make Norg checklist items parse and toggle in nvim-orgmode by verifying filetype Treesitter parser activation and the checklist toggle action, with checks and recovery steps.
25 Feb 2026, 13:06 UTC

The problem
Checklist items in a .norg file may appear as plain text without Treesitter parsing highlighting or toggle functionality. The useful takeaway is that nvim-orgmode requires a correct filetype an active norg Treesitter parser and an accessible checklist toggle for the buffer to recognize and modify bracket markers in place.
Desired outcome
A test .norg file where checklist items written with Norg list syntax are parsed by the Treesitter grammar highlighted as checklist markers and toggled between unchecked checked and cancelled states without manual editing.
Prerequisites
- Neovim with Lua runtime
- nvim-orgmode installed and loaded for *.norg files
- Working Treesitter parser for norg
- Test directory with write permission
- Editor configured to set filetype=norg for .norg buffers
Create a minimal test file
Create test.norg in a writable directory. Add a minimal list using Norg list syntax:
- [ ] first task - [x] done task - [-] cancelled taskThe three bracket forms represent unchecked checked and cancelled states in the norg grammar used by nvim-orgmode.
Open and verify recognition
Open the file in Neovim from the terminal in the file's directory. With the file open run:
:echo &filetypeExpected check: the buffer reports norg. If not set it explicitly with :set filetype=norg.
Confirm Treesitter is active for the buffer. Run:
:TSBufEnable norgThen inspect the syntax node under a checklist line. Place the cursor on a line like - [ ] first task and run the Treesitter inspector. The node should be a list item containing a checkbox marker. Visual highlighting depends on colorscheme so also verify raw characters remain - [ ] - [x] - [-] in the buffer.
Toggle a checklist item
nvim-orgmode exposes a checklist toggle action for norg. The exact keybinding is user dependent. Check your current mappings with :map and look for a mapping related to orgmode checklist toggle. Place the cursor on the checkbox marker of a list item and invoke the toggle action. The bracket characters should change in place e.g. - [ ] becomes - [x] and the surrounding list indentation is preserved. Risk: invoking the wrong mapping can edit the line text. Verify before and after buffer content for a single list item and confirm only the bracket characters change.
Expected checks
- Filetype remains norg after opening and after toggle.
- Treesitter reports a norg parser for the buffer.
- The three bracket forms are highlighted as checklist markers under your colorscheme.
- Toggling updates the character sequence in place without corrupting indentation.
Limitations and recovery
Parser behavior is version sensitive; older nvim-orgmode releases used a different grammar and checklist syntax may not be recognized. If recognition fails reset filetype with :set filetype=norg reload nvim-orgmode or reinstall the norg Treesitter parser. Checklist toggle commands differ by user mapping. If no mapping is found consult your nvim-orgmode configuration for the command exposed for norg checklists. Highlighting depends on colorscheme. Visual confirmation may require inspecting raw characters. Recovery options that change state: remove the test file and recreate it with minimal syntax to isolate a parsing conflict; reload the plugin to reattach keymaps and parser.
0 replies
A thoughtful contribution can make all the difference. Be the first to share one.