https://github.com/kylechui/config.nvim

A remote backup for my Neovim config. Written with :heart: in Lua.
https://github.com/kylechui/config.nvim

lua neovim

Last synced: about 5 hours ago
JSON representation

A remote backup for my Neovim config. Written with :heart: in Lua.

• Host: GitHub
• URL: https://github.com/kylechui/config.nvim
• Owner: kylechui
• License: mit
• Created: 2021-05-13T23:01:15.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-30T00:18:03.000Z (7 months ago)
• Last Synced: 2024-05-02T03:11:03.292Z (7 months ago)
• Topics: lua, neovim
• Language: Lua
• Homepage:
• Size: 1.46 MB
• Stars: 23
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# config.nvim

My Lua configuration for Neovim on Linux (some features work on Windows). I

mainly use this setup for [taking notes](https://github.com/kylechui/latex) and

doing homework in LaTeX, as well as light programming in Lua, OCaml, etc.

[Obligatory link to Castel's blog.](https://castel.dev/post/lecture-notes-1/)

## Screenshot

- Font:

  [JetBrains Mono Nerd Font](https://github.com/ryanoasis/nerd-fonts/tree/master/patched-fonts/JetBrainsMono/Ligatures)

  (can be changed in

  [settings](https://github.com/kylechui/config.nvim/blob/f8ed82242dd8b55271ea2f3b453d15b9be8d5df9/lua/settings.lua#L13))

- Colorscheme: [kanagawa](https://github.com/rebelot/kanagawa.nvim)

- Terminal: I use [WezTerm](https://github.com/wez/wezterm) as my interface of

  choice

![nvim](./screenshot.png) ![nvim](./screenshot2.png)

## Dependencies

- Requires [Neovim 0.8+](https://github.com/neovim/neovim/releases) for Lua

  integration

- Requires a PDF reader if you want to view compiled LaTeX documents:

  - Linux: [Zathura](https://pwmt.org/projects/zathura/)

  - Windows:

    [SumatraPDF](https://www.sumatrapdfreader.org/download-free-pdf-viewer)

- \[Optional] Requires Node.js and yarn for

  [live previewing markdown files](https://github.com/iamcco/markdown-preview.nvim)

  of choice

## Setup

I use [lazy.nvim](https://github.com/folke/lazy.nvim) to manage all of my

packages. The general hierarchy for how things are configured is as follows:

    after

    └── ftplugin

        └── ...

    queries

    └── ...

    lua

    ├── autocommands.lua

    ├── keymaps.lua

    ├── settings.lua

    ├── utils.lua

    └── plugins

        └── ...

    └── luasnippets

        └── ...

- `ftplugin/` -- Stores various settings for specific file types

- `queries/` -- Some scheme files for Tree-sitter parsing that define swappable

  groups, stored in `[fileType]/textobjects.scm`

- `autocommands.lua` -- Defines a few useful autocommands

- `keymaps.lua` -- Stores various key maps

- `settings.lua` -- General settings and options

- `utils.lua` -- Some helper functions

- `plugins/` -- A folder full of the configurations needed for each individual

  plugin

- `luasnippets/` -- My snippets configuration for each language I use, stored in

  the form `luasnippets/[fileType].lua`