diff --git a/README.md b/README.md index 41a2a12..16845d7 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,26 @@ nvim +PackerSync ``` +## Useful info + +- Folding with treesitter + - To get folding for your language, you need to run + `:TSInstall ` (eg. `TSInstall cpp` to get C++ folding) +- Install language servers + - Use `Space+p+I` keybind to open install menu. + - To install package under the cursor, press `i` + - To uninstall package under the cursor press `X` +- Debugging + - See `vimspector` under [`Extra plugin included`](#extra-plugins-included) +- LaTeX + - To use `vimtex` plugin, you need to have LaTeX installed + - [`texlive-most`](https://wiki.archlinux.org/title/TeX_Live#Installation) package on ArchLinux +- PlatformIO + - If you want to use PlatformIO, you need to have `pio` installed + - To create a project, run `:PIONewProject` + - To include a library, run `:PIOAddLibrary` + - For more commands, go to [`vim-pio`'s repository](https://github.com/jiriks74/vim-pio) + ## Extra plugins included - [vimspector](https://github.com/puremourning/vimspector) @@ -66,13 +86,13 @@ nvim +PackerSync ## Extra mappings -| Shortcut | Vim keybind | Description | -|----------|-----------------|-------------------| -| Space+a | ["\a"] | Alpha Dashboard | -| CTRL+e | ["\"] | Copilot accept | -| CTRL+s | ["\"] | Toggle autosave | +| Shortcut | Vim keybind | Description | +|----------|------------------|-------------------| +| Space+a | ["\uD"] | Alpha Dashboard | +| CTRL+e | ["\"] | Copilot accept | +| CTRL+s | ["\"] | Toggle autosave | -- Mappings for vimspector (debugging) +### Mappings for vimspector (debugging) | Shortcut | Vim keybind | Description | |-------------|-------------------|--------------------| @@ -103,10 +123,27 @@ nvim +PackerSync There are also some [VSCode like keybinds setup by the plugin](https://github.com/puremourning/vimspector#visual-studio--vscode) -- Mappings for markdown preview +### Mappings for markdown preview | Shortcut | Vim keybind | Description | |-----------|------------------|-------------------------| | Space+m+p | ["\mp"] | Markdown preview | | Space+m+s | ["\ms"] | Markdown preview stop | | Space+m+t | ["\mt"] | Markdown preview toggle | + +### Mappings for `vimtex` + +## TODO + +- [ ] [Mappings for `vimtex`](#mappings-for-vimtex) +- [ ] Better section for `vim-pio` +- [ ] Add section for setting up debugging +- [ ] Add mappings for `treesitter` install? +- [ ] Add requirements section + - So you don't have to go through [Extra plugins included](#extra-plugins-included) to know what to install +- [ ] Better [`README.md`](https://github.com/jiriks74/astronvim_config/blob/neovim7.2/README.md) + for [`neovim7.2`](https://github.com/jiriks74/astronvim_config/tree/neovim7.2) branch + - [ ] Add section redirecting to [`neovim72`](https://github.com/jiriks74/astronvim_config/tree/neovim7.2) + branch's [`README.md`](https://github.com/jiriks74/astronvim_config/blob/neovim7.2/README.md) it user has Neovim < 8.0 +- [ ] Add `.vimspector.json` template +- [ ] Setting up simple wiki? diff --git a/init.lua b/init.lua index 9a522c9..5121b3e 100644 --- a/init.lua +++ b/init.lua @@ -44,6 +44,8 @@ local config = { spell = true, -- sets vim.opt.spell signcolumn = "auto", -- sets vim.opt.signcolumn to auto wrap = false, -- sets vim.opt.wrap + foldexpr = "nvim_treesitter#foldexpr()", -- set Treesitter based folding + foldmethod = "expr", }, g = { mapleader = " ", -- sets vim.g.mapleader @@ -199,6 +201,7 @@ local config = { ["bc"] = { "BufferLinePickClose", desc = "Pick to close" }, ["bj"] = { "BufferLinePick", desc = "Pick to jump" }, ["bt"] = { "BufferLineSortByTabs", desc = "Sort by tabs" }, + ["uD"] = { "Alpha", desc = "Alpha dashboard" }, ["dd"] = { "call vimspector#Launch()", desc = "Launch" }, ["dS"] = { "call vimspector#Stop()", desc = "Stop" },