34 lines
1.8 KiB
Markdown
34 lines
1.8 KiB
Markdown
# Product Context
|
|
|
|
## Purpose
|
|
Kickstart.nvim is a Neovim configuration starting point designed to be:
|
|
- **Small and manageable**
|
|
- **Single-file based** (with modular options available)
|
|
- **Completely documented**
|
|
- **Educational and customizable**
|
|
|
|
## Problems Solved
|
|
Kickstart.nvim addresses the following challenges:
|
|
1. **Quick Start**: Provides an easy entry point for new Neovim users without overwhelming them.
|
|
2. **Documentation**: Offers a well-documented foundation that users can learn from and modify.
|
|
3. **Simplified Setup**: Reduces the complexity of the initial Neovim setup.
|
|
4. **Balanced Features**: Strikes a balance between functionality and simplicity.
|
|
|
|
## How It Works
|
|
Kickstart.nvim operates through the following steps:
|
|
1. **Cloning**: Users clone the repository into their Neovim configuration directory.
|
|
2. **Automatic Installation**: The configuration automatically installs `lazy.nvim`, the plugin manager.
|
|
3. **Core Features**: Loads core features through a well-documented `init.lua` file.
|
|
4. **Plugins System**: Additional features can be enabled through the plugins system.
|
|
5. **Customization**: Users can extend functionality with custom plugins located in `lua/custom/plugins/`.
|
|
|
|
## Key Features
|
|
Kickstart.nvim includes the following key features:
|
|
1. **LSP Integration**: Supports Language Server Protocol for enhanced coding assistance.
|
|
2. **Syntax Highlighting**: Utilizes Treesitter for advanced syntax highlighting.
|
|
3. **Fuzzy Finding**: Includes Telescope for efficient fuzzy finding.
|
|
4. **Git Integration**: Provides seamless Git integration.
|
|
5. **Auto-completion**: Supports auto-completion for faster coding.
|
|
6. **File Navigation**: Facilitates easy file navigation.
|
|
7. **Custom Keymaps**: Allows custom key mappings for an improved workflow.
|
|
8. **Formatting Support**: Comes with built-in formatting support. |