tomas.mirchev/nvim-tree.lua
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: reformat quickstart readme example (#2258)

Browse Source
This commit is contained in:
Sander 2023-06-05 01:10:57 +02:00 committed by GitHub
parent 63061404f4
commit f5d970d450
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -79,27 +79,27 @@ require("nvim-tree").setup({
Optionally customise your mappings, see [:help nvim-tree-mappings](doc/nvim-tree-lua.txt) Optionally customise your mappings, see [:help nvim-tree-mappings](doc/nvim-tree-lua.txt)
```lua ```lua
local function my_on_attach(bufnr) local function my_on_attach(bufnr)
local api = require "nvim-tree.api" local api = require "nvim-tree.api"
local function opts(desc) local function opts(desc)
return { desc = "nvim-tree: " .. desc, buffer = bufnr, noremap = true, silent = true, nowait = true } return { desc = "nvim-tree: " .. desc, buffer = bufnr, noremap = true, silent = true, nowait = true }
end
-- default mappings
api.config.mappings.default_on_attach(bufnr)
-- custom mappings
vim.keymap.set('n', '<C-t>', api.tree.change_root_to_parent, opts('Up'))
vim.keymap.set('n', '?', api.tree.toggle_help, opts('Help'))
end end
-- pass to setup along with your other options -- default mappings
require("nvim-tree").setup { api.config.mappings.default_on_attach(bufnr)
---
on_attach = my_on_attach, -- custom mappings
--- vim.keymap.set('n', '<C-t>', api.tree.change_root_to_parent, opts('Up'))
} vim.keymap.set('n', '?', api.tree.toggle_help, opts('Help'))
end
-- pass to setup along with your other options
require("nvim-tree").setup {
---
on_attach = my_on_attach,
---
}
``` ```
Open the tree: `:NvimTreeOpen` Open the tree: `:NvimTreeOpen`