Skip to content

Commit

Permalink
docs: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Allaman committed Jan 16, 2025
1 parent e0fb5eb commit fe27170
Showing 1 changed file with 72 additions and 0 deletions.
72 changes: 72 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,78 @@

![SXOsw.png](https://s7.gifyu.com/images/SXOsw.png)

**Terminal**: [ghostty](https://s7.gifyu.com/images/SXOsw.png)
**Font**: [Comic Code Ligatures](https://tosche.net/fonts/comic-code)
**Neovim Theme**: default

**README WIP**

Check failure on line 31 in README.md

View workflow job for this annotation

GitHub Actions / checks

Emphasis used instead of a heading

README.md:31 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "README WIP"] https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md036.md

## Customization

⚠️ This is primarly my personal config

If you want to use my config there is the `./lua/vnext/extra/` folder that is loaded by lazy.nvim. The LazySpecs in this folder are merged with the "defaul" LazySpecs in the `./lua/vnext/plugins/` folder. Some examples you can do:

Disable a plugin:

```lua
return {
{
"Bekaboo/dropbar.nvim",
enabled = false,
},
}
```

Add new options to a plugin:

```lua
return {
{
"echasnovski/mini.surround",
opts = {
search_method = 'nearest',
},
}
}
```

Overwrite options of a plugin:

```lua
return {
{
"L3MON4D3/LuaSnip",
opts = {
-- define your own snippets folder
snippets_path = { vim.fn.expand("~/mySnips") },
},
},
}
```

Change keys of a plugin:

```lua
return {
{
"MagicDuck/grug-far.nvim",
keys = {
-- stylua: ignore start
{ "<leader>R", hidden = true },
{ "<leader>RG", "<cmd>GrugFar<cr>", desc = "Open" },
{ "<leader>Rg", "<cmd>lua require('grug-far').open({ prefills = { paths = vim.fn.expand('%') } })<cr>", desc = "Open (Limit to current file)"},
{ "<leader>Rw", "<cmd>lua require('grug-far').open({ prefills = { search = vim.fn.expand('<cword>') } })<cr>", desc = "Search word under cursor", },
{ "<leader>Rs", mode = "v", "<cmd>lua require('grug-far').with_visual_selection({ prefills = { paths = vim.fn.expand('%') } })<cr>", desc = "Search selection", },
{ "<leader>X", "", desc = "Search & Replace" },
{ "<leader>XG", "<cmd>GrugFar<cr>", desc = "Open" },
{ "<leader>Xg", "<cmd>lua require('grug-far').open({ prefills = { paths = vim.fn.expand('%') } })<cr>", desc = "Open (Limit to current file)"},
{ "<leader>Xw", "<cmd>lua require('grug-far').open({ prefills = { search = vim.fn.expand('<cword>') } })<cr>", desc = "Search word under cursor", },
{ "<leader>Xs", mode = "v", "<cmd>lua require('grug-far').with_visual_selection({ prefills = { paths = vim.fn.expand('%') } })<cr>", desc = "Search selection", },
-- stylua: ignore end
},
},
}
```

Check out my [blog post](https://rootknecht.net/blog/debloating-neovim-config/) to learn more about the reasons behind this big change. You can find the previous version in the [v1](https://github.com/Allaman/nvim/tree/v1) branch.

0 comments on commit fe27170

Please sign in to comment.