doc: default mappings

This commit is contained in:
Alexander Courtis
2022-05-30 12:53:28 +10:00
committed by GitHub
parent 5e900c2f29
commit 8198fa01fc
7 changed files with 567 additions and 266 deletions

View File

@@ -15,10 +15,11 @@ cargo install stylua
## Adding new actions
To add a new action, add a file in `actions/name-of-the-action.lua`. You should export a `setup` function if some configuration is needed.
Once you did, you should run the `scripts/update-default-opts.sh` which will update the default documentation in the README and the help file.
## Documentation
When adding new options, you should declare the defaults in the main `nvim-tree.lua` file.
Once you did, you should run the `update-default-opts.sh` script which will update the default documentation in the README and the help file.
Once you did, you should run the `scripts/update-default-opts.sh` which will update the default documentation in the README and the help file.
Documentation for options should also be added, see how this is done after `nvim-tree.disable_netrw` in the `nvim-tree-lua.txt` file.