README.org

Nvim

NOTE: This ~README~ is outdated, the project structure has been fully changed. The profile requires Neovim nightly now.

My personal Neovim configuration, which keeps the structure simple and straightforward by logically distributing the configuration into various directories. Aims to be highly customizable and have no hacks.

Table of Contents

• Introduction
• Directory Structure

Introduction

This configuration doesn’t break any of Neovim’s default keymaps, except for s, the source-level equivalent of cl, s is used as the easymotion-prefix(In fact the functionality of easymotion is provided by a plugin called hop.nvim).

This configuration contains more than 100 plugins, but the configuration of each plugin is placed in a separate file, and these files are classified into different modules according to the function of the plugin and placed in different folders.

In addition, all configuration options and keymaps for each plugin are listed in their respective files, making it easy to adjust individual options without having to look up the manual.

The configuration structure is as shown in the figure below.

                  │                             ┌──────────────────┐
nvim/                 nvim/lua                  │ Core Module      │
                  │                             │ ┌──────────────┐ │
                                                │ │lspconfig.lua │ │
                  │    ┌───────────┐            │ └──────────────┘ │
                       │keymaps.lua│     ┌─────►│                  │
                  │    └───────────┘     │      │ ┌──────────────┐ │
                      Keymap for lazy    │      │ │treesitter.lua│ │
                  │   loading plugins    │      │ └──────────────┘ │
                             ▲           │      │                  │
                  │          │           │      │  ...other files  │
                             │           │      └──────────────────┘
   ┌──────────┐   │    ┌─────┴────┐      │
   │ init.lua ├───────►│ init.lua │      │      ┌──────────────────┐
   └──────────┘   │    └──────────┘      │      │ Interface Module │
  Neovim common        Neovim extra      │      │ ┌──────────────┐ │
  configuration   │    configuration     │      │ │bufferline.lua│ │
                             │           │      │ └──────────────┘ │
                  │          │           │      │                  │
                             ▼           │      │ ┌──────────────┐ │
                  │    ┌───────────┐     │      │ │ lualine.lua  │ │
                       │plugins.lua├─────┼─────►│ └──────────────┘ │
                  │    └───────────┘     │      │                  │
                     Plugin management,  │      │  ...other files  │
                  │ calling each module  │      └──────────────────┘
                                         │
                  │                      │      ┌──────────────────┐
                                         └─────►│ ...other modules │
                  │                             └──────────────────┘

Directory Structure

├── lua
│   ├── core # Core plugins, often depended on by other plugins
│   │   ├── lspconfig.lua
│   │   ├── treesitter.lua
│   │   └── ...
│   ├── debug # Debug and run
│   │   ├── dap.lua
│   │   ├── dap-ui.lua
│   │   └── ...
│   ├── edit # Text edting
│   │   ├── cmp.lua
│   │   ├── copilot.lua
│   │   └── ...
│   ├── efficiency # Efficiency Improvement
│   │   ├── session-manager.lua
│   │   ├── telescope.lua
│   │   └── ...
│   ├── interface # Interface Extension
│   │   ├── bufferline.lua
│   │   ├── lualine.lua
│   │   └── ...
│   ├── language # Language Specific
│   │   ├── jdtls.lua
│   │   └── tex.lua
│   ├── tool # Tool Integration
│   │   ├── gitsigns.lua
│   │   ├── tree.lua
│   │   └── ...
│   ├── plugins.lua # Plugin management
│   ├── keymaps.lua # Keymap for lazy loading plugins
│   └── init.lua # Neovim extra configuration
├── .gitignore
├── stylua.toml
├── LICENSE
├── README.org
└── init.lua # Neovim common configuration