astronvim_config/README.md
Jiří Štefka caeeb528b3
All checks were successful
Luacheck / Luacheck (push) Successful in 8s
StyLua / StyLuacheck (push) Successful in 13s
Remove notice from GitHub repo's README
2024-01-19 02:06:55 +01:00

4 KiB

My AstroNvim config

README for the merlin server at FIT VUT can be found here

How to install my config

  • 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
    
  • Clone my config into ~/.config/nvim/lua/user

    git clone https://github.com/jiriks74/astronvim_config ~/.config/nvim/lua/user
    

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+m keybind to open install menu.
      • To install package under the cursor, press i
      • To uninstall package under the cursor press X
  • 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

  • You have to create a file with Launch config - see the plugin repository
  • 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 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