https://github.com/qqphp/nvimdots_config
https://github.com/qqphp/nvimdots_config
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/qqphp/nvimdots_config
- Owner: qqphp
- License: mit
- Created: 2023-09-19T02:57:25.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-10T01:01:30.000Z (over 2 years ago)
- Last Synced: 2025-01-12T14:47:35.275Z (about 1 year ago)
- Language: Lua
- Size: 129 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
nvimdots
## 🪷 Introduction
This repo hosts our [NeoVim](https://neovim.io/) configuration for Linux [(with NixOS support)](#nixos-support), macOS, and Windows. `init.lua` is the config entry point.
Branch info:
| Branch | Supported neovim version |
| :----: | :----------------------: |
| main | nvim 0.9 stable |
| 0.8 | nvim 0.8 |
| 0.7 | nvim 0.7 |
We currently manage plugins using [lazy.nvim](https://github.com/folke/lazy.nvim).
Chinese introduction is [here](https://zhuanlan.zhihu.com/p/382092667).
### 🎐 Features
- **Fast.** Less than **30ms** to start (Depends on SSD and CPU, tested on Zephyrus G14 2022 version).
- **Simple.** Run out of the box.
- **Modern.** Pure `lua` config.
- **Modular.** Easy to customize.
- **Powerful.** Full functionality to code.
## 🏗 How to Install
Just run the following interactive bootstrap command, and you're good to go 👍
- **Windows** _(Note: This script REQUIRES `pwsh` > `v7.1`)_
```pwsh
Set-ExecutionPolicy Bypass -Scope Process -Force; Invoke-Expression ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/ayamir/nvimdots/HEAD/scripts/install.ps1'))
```
- **\*nix**
```sh
if command -v curl >/dev/null 2>&1; then
bash -c "$(curl -fsSL https://raw.githubusercontent.com/ayamir/nvimdots/HEAD/scripts/install.sh)"
else
bash -c "$(wget -O- https://raw.githubusercontent.com/ayamir/nvimdots/HEAD/scripts/install.sh)"
fi
```
It's strongly recommended to read [Wiki: Prerequisites](https://github.com/ayamir/nvimdots/wiki/Prerequisites) before starting, especially for \*nix users.
## ⚙️ Configuration & Usage
🗺️ Keybindings
See Wiki: Keybindings for details
🔌 Plugins & Deps
See Wiki: Plugins for details
(You can also find a deps diagram there!)
🔧 Usage & Customization
See Wiki: Usage for details
❄️ NixOS Support
See Wiki: NixOS Support for details
🤔 FAQ
See Wiki: FAQ for details
## ✨ Features
⏱️ Startup Time
> Tested with [rhysd/vim-startuptime](https://github.com/rhysd/vim-startuptime)
📸 Screenshots
Dashboard
Telescope
Coding
Code Action
Debugging
Lazygit with built-in Terminal
Command quickref
## 👐 Contributing
- If you find anything that needs improving, do not hesitate to point it out or create a PR.
- If you come across an issue, you can first use `:checkhealth` command provided by nvim to trouble-shoot yourself.
- If you still have such problems, feel free to open a new issue!
## ❤️ Thanks to
- [ayamir](https://github.com/ayamir)
- [Jint-lzxy](https://github.com/Jint-lzxy)
- [CharlesChiuGit](https://github.com/CharlesChiuGit)
## 🎉 Acknowledgement
- [glepnir/nvim](https://github.com/glepnir/nvim)
## 📜 License
This NeoVim configuration is released under the MIT license, which grants the following permissions:
- Commercial use
- Distribution
- Modification
- Private use
For more convoluted language, see the [LICENSE](https://github.com/ayamir/nvimdots/blob/main/LICENSE).