8.Troubleshooting

Troubleshooting

Health Check

markdown-plus.nvim includes a comprehensive health check that validates your configuration and reports any issues. Run it with:

:checkhealth markdown-plus

The health check will verify:

• ✅ Neovim version (requires 0.11+)
• ✅ Lua/LuaJIT version
• ✅ Plugin configuration validity
• ✅ Enabled features status
• ✅ Configured filetypes
• ✅ Keymap configuration
• ⚠️ Plugin conflicts (e.g., with vim-markdown)
• 📦 Development dependencies (for contributors)

If you encounter any issues, run the health check first - it will often identify the problem and suggest solutions.

Common Issues

Plugin not working / keymaps not active

1. Ensure the plugin loaded for your buffer:

   :lua print(vim.g.loaded_markdown_plus)

   Should print 1. If not, the plugin didn't load.

2. Check your filetype:

   :set filetype?

   By default, the plugin only loads for markdown filetype. See Configuration to enable for other filetypes.

3. Run the health check:

   :checkhealth markdown-plus

Keymaps conflicting with other plugins

If you have keymap conflicts with other plugins (like vim-markdown), you have two options:

1. Disable markdown-plus default keymaps and create custom ones:

   require("markdown-plus").setup({
     keymaps = {
       enabled = false,
     },
   })
   
   -- Then create custom keymaps
   vim.keymap.set("n", "<leader>mb", "<Plug>(MarkdownPlusBold)")

2. Disable conflicting keymaps from the other plugin. See the other plugin's documentation.

The health check will warn you about detected conflicts.

Lists not auto-continuing

1. Check that list management is enabled:

   :checkhealth markdown-plus

2. Ensure you're in insert mode when pressing Enter

3. Verify the line is recognized as a list item. The plugin supports:

   • Unordered: -, *, +
   • Ordered: 1., 2., etc.
   • Letter: a., b., A., B., etc.
   • Parenthesized: 1), a), A), etc.
   • With checkboxes: - [ ], 1. [x], etc.