weeheavy/neovim
1
1
Fork 0
Code Issues Activity

documentation

Browse source
This commit is contained in:
Oliver Ladner 2023-11-21 13:29:49 +01:00
commit 3c5884ee4a
2 changed files with 22 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -3,17 +3,21 @@
## Motivation ## Motivation
After doing my first steps with <https://github.com/nvim-lua/kickstart.nvim>, After doing my first steps with <https://github.com/nvim-lua/kickstart.nvim>,
I decided to roll my own, custom, "lightweight" Neovim configuration in order to: I decided to roll my own, custom, "lightweight" Neovim configuration in order to
better understand Neovim and its configuration/customization, package managers,
LSP etc. and have "my own" config that only includes things I really need.
- better understand Neovim and configuration/customization, package managers, LSP etc. ## Installation
- Have "my own" config that only includes things I really need
## Benefits for other people? 1. Install Neovim 0.9.x
1. Install OS dependencies documented in `init.lua`
1. Clone this Git repository to `~/.config/nvim`
Not sure if there are any, but I added comments where I
thought they are necessary.
`init.lua` documents any needed external dependencies. ### Finishing touches
- Install Treesitter comment parser (to highlight `FIXME:/NOTE:/TODO:/XXX:`) with `:TSInstall comment`
- Create a `$HOME/.ignore` file and add big, useless directories to it, so Telescope/ripgrep/fd can ignore those. Details in `lua/weeheavy/plugins/telescope-fzf-native.lua`
## Speed ## Speed
@ -71,7 +75,7 @@ This is more accurate than `nvim --startuptime`.
### Telescope ### Telescope
#### File search #### Telescope file search
- `Ctrl+n` scroll down (**n**ext) file list - `Ctrl+n` scroll down (**n**ext) file list
- `Ctrl+p` scroll up (**p**revious) file list - `Ctrl+p` scroll up (**p**revious) file list
@ -81,3 +85,11 @@ This is more accurate than `nvim --startuptime`.
### Treesitter ### Treesitter
- `:TSUpdate` update all parsers - `:TSUpdate` update all parsers
- `:TSModuleInfo` show installed parsers
## Open issues/TODOs
- Git handling in general
- Directory browsing with Telescope
- Solution to show short Git logs (potentially without fugitive)
- Hinting for trailing spaces (EOL) and blank space on line

7
init.lua
View file

@ -2,13 +2,10 @@
My simple Neovim configuration. Made from scratch, inspired by My simple Neovim configuration. Made from scratch, inspired by
https://www.youtube.com/watch?v=w7i4amO_zaE https://www.youtube.com/watch?v=w7i4amO_zaE
EXTERNAL DEPENDENCIES: EXTERNAL DEPENDENCIES
- ripgrep (https://github.com/BurntSushi/ripgrep, used by telescope) - ripgrep (https://github.com/BurntSushi/ripgrep, used by telescope)
- fd (https://github.com/sharkdp/fd, used by telescope) - fd (https://github.com/sharkdp/fd, used by telescope)
- Nerd font (https://www.nerdfonts.com/, used by nvim-web-devicons) - A Nerd font (https://www.nerdfonts.com/, used by nvim-web-devicons)
CHANGELOG:
- 2023-11-20: init, lazy, fuzzy, remaps
--]] --]]
-- Include customized configuration -- Include customized configuration