From 6697a4768360b1a397de86e02f902df981fa09e2 Mon Sep 17 00:00:00 2001 From: Alex Rod Date: Tue, 26 Nov 2024 09:48:42 +0100 Subject: [PATCH] Update docs on how to disable default keymaps I was having trouble disabling using LazyVim because I was updating the variable in the `config` function. Decided to make it clear that this needs to happen before the plugin gets loaded --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 97da2f01..ea4a8631 100644 --- a/README.md +++ b/README.md @@ -202,7 +202,21 @@ useful if your system is read-only or uses immutable datastructures. Default: `1` -Whether to enable built-in mappings. If you decide to disable this, then you can +Whether to enable built-in mappings. + +To disable: +```vim +let g:doge_enable_mappings = 0 +``` + +Or with lua +```lua +-- be sure to call this before the plugin gets loaded. +-- For example, in LazyVim, call in `init` +vim.api.nvim_set_var('doge_enable_mappings', 0) +``` + +If you decide to disable this, then you can copy the mappings below and change them to your needs: ```vim