jiriks74/astronvim_config
1
0
Fork 0
Code Issues 3 Pull Requests Actions Projects 1 Wiki Activity
merlin
astronvim_config/README.md

6.8 KiB
Raw Permalink Blame History

My AstroNvim config

How to install my config on merli

  • First you have to install AstroNvim

    • Backup your previous nvim config
    mv ~/.config/nvim ~/.config/nvimbackup
    • Clone AstroNvim repository into ~/.config/nvim
    git clone https://github.com/AstroNvim/AstroNvim ~/.config/nvim
nvim +PackerSync

  • Clone my config into ~/.config/nvim/lua/user

    • For NeoVim >= 8.0
    git clone https://github.com/jiriks74/astronvim_config ~/.config/nvim/lua/user

  • Open nvim and run :PackerSync

    • This will result in errors as merlin kills most of the clone processes
    • To make this work you need to press R (yes, capital) to download all the failed downloads
      • You have to do this until all plugins have been successfully downloaded
nvim +PackerSync

Updating

cd ~/.config/nvim
git pull
cd lua/user
git pull
  • To update the plugins you need to first remove all the downloaded plugins (or plugin downloading will fail)
rm -rf ~/.local/share/nvim

  • Then you need to repeat the process as if you were initializing AstroNvim for the first time:

    • Open nvim and run :PackerSync
      • This will result in errors as merlin kills most of the clone processes
      • To make this work you need to press R (yes, capital) to download all the failed downloads
        • You have to do this until all plugins have been successfully downloaded
    nvim +PackerSync

Useful info

  • Folding with treesitter
    • To get folding for your language, you need to run :TSInstall <language> (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
  • LaTeX
    • To use vimtex plugin, you need to have LaTeX installed
  • 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

Extra plugins included

  • vimspector

    • Simple plugin for debugging
    • You need have to have neovim python module installed
    pip3 install neovim

  • vim-pio

    • PlatformIO vim plugin
    • This is a fork that I modified to work with clangd as this is what is the easiest to setup in AstroNvim

  • vimtex

    • A plugin for, you guessed it, LaTex
    • I have not yet learned LaTex, so I haven't tried this plugin out.
    • This plugin needs you to have LaTeX installed on your system. To see more go to the vimtex repository Hopefully I'll learn it and try out this plugin soon

  • markdown-preview.nvim

    • Plugin for live markdown preview in a web browser

  • copilot.vim

    • Github's copilot plugin for Vim
    • To use the plugin you have to login with this command
      • :Copilot setup

  • Pocco81/auto-save.nvim

    • Plugin for autosave

Extra mappings

Shortcut Vim keybind Description
Space+a ["<leader>uD"] Alpha Dashboard
CTRL+e ["<C-e>"] Copilot accept
CTRL+s ["<C-s>"] Toggle autosave

Mappings for vimspector (debugging)

Shortcut Vim keybind Description
Space+d+d ["<leader>dd"] Launch
Space+d+S ["<leader>dS"] Stop
Space+d+c ["<leader>dc"] Continue
Space+d+p ["<leader>dp"] Pause
Space+d+e ["<leader>de"] Reset
Space+d+r ["<leader>dr"] Restart
Space+d+R ["<leader>dR"] Run to cursor
Space+d+C ["<leader>dC"] Go to current line
Space+d+P ["<leader>dP"] Move cursor to the program counter in current frame
Breakpoints
Space+d+b+t ["<leader>dbt"] Toggle breakpoint
Space+d+b+l ["<leader>dbl"] List breakpoints
Space+d+b+c ["<leader>dbc"] Clear breakpoints
Space+d+b+C ["<leader>dbC"] Toggle CBreakpoint or LogPoint on current line
Space+d+b+f ["<leader>dbf"] Add a function breakpoint for expression under cursor
Space+d+b+n ["<leader>dbn"] Jump to next breakpoint
Space+d+b+p ["<leader>dbp"] Jump to previous breakpoint
Step keybinds
Space+d+s+s ["<leader>dss"] Step over
Space+d+s+i ["<leader>dsi"] Step into
Space+d+s+o ["<leader>dso"] Step out
Frame keybinds
Space+d+f+u ["<leader>dfu"] Up frame
Space+d+f+d ["<leader>dfd"] Down frame

There are also some VSCode like keybinds setup by the plugin

Mappings for markdown preview

Shortcut Vim keybind Description
Space+m+p ["<leader>mp"] Markdown preview
Space+m+s ["<leader>ms"] Markdown preview stop
Space+m+t ["<leader>mt"] Markdown preview toggle

Mappings for vimtex

TODO