kickstart.nvim 简介

简介
安装

简介

这是一个 Neovim 的起点配置，特点是：

小巧
单文件
完全有注释

它不是一个 Neovim 发行版，而是你自定义配置的起点。

安装

安装 Neovim

Kickstart.nvim 只支持最新的 Neovim
‘stable 稳定版’ 和
‘nightly 每日构建版’。
如果你遇到问题，请确认你用的是最新版。

安装外部依赖

外部依赖包括：

基础工具：git、make、unzip、C 编译器（比如 gcc）
ripgrep
剪贴板工具（xclip / xsel / win32yank 或其他，视平台而定）
一个 Nerd Font（可选，用于显示图标）
- 如果安装了的话，可以在 init.lua 里设置 vim.g.have_nerd_font = true
Emoji 字体（仅限 Ubuntu，且你真的想要 emoji）：sudo apt install fonts-noto-color-emoji
编程语言支持：
- 如果你想写 Typescript，需要装 npm
- 如果你想写 Golang，需要装 go
- 等等

[!NOTE]
具体平台的安装方法可以看 Install Recipes

安装 Kickstart

[!NOTE]
如果你之前有自己的配置，记得先备份

Neovim 的配置默认在以下路径：

操作系统	路径
Linux, MacOS	`$XDG_CONFIG_HOME/nvim` 或 `~/.config/nvim`
Windows (cmd)	`%localappdata%\nvim\`
Windows (powershell)	`$env:LOCALAPPDATA\nvim\`

克隆 kickstart.nvim

[!NOTE]
如果你上一步 Fork 了项目，那下面的命令里要把 nvim-lua 替换成你的用户名。

Linux 和 Mac

sh
git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim

Windows

如果你用的是 cmd.exe： git clone https://github.com/nvim-lua/kickstart.nvim.git "%localappdata%\nvim" 如果你用的是 powershell.exe： git clone https://github.com/nvim-lua/kickstart.nvim.git "${env:LOCALAPPDATA}\nvim"

安装完成后

启动 Neovim：

nvim

搞定！Lazy 会自动帮你装好所有插件。用 :Lazy 可以查看插件状态，按 q 关闭窗口。

看文档！

打开你的配置目录下的 init.lua，阅读其中的注释，
里面有扩展和定制 Neovim 的建议，还包括常用插件的添加示例。

[!NOTE]
想了解某个插件的用法可以看它对应仓库的文档。

快速上手

FAQ

如果我已经有自己的 Neovim 配置怎么办？
- 先备份旧配置，然后删掉旧文件，
  包括 init.lua 和 ~/.local 下的 Neovim 文件：
  rm -rf ~/.local/share/nvim/
我能同时保留自己的配置和 kickstart 吗？
- 可以！你可以用环境变量 NVIM_APPNAME=nvim-NAME 来切换多个配置。
  比如你可以把 kickstart 安装到 ~/.config/nvim-kickstart，然后加个别名：
```
alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
```
  用这个别名启动 Neovim 时，会自动使用 ~/.config/nvim-kickstart 和 ~/.local/share/nvim-kickstart。
我想“卸载” kickstart 怎么办？
- 看这篇 lazy.nvim uninstall 指南。
为什么 kickstart 的 init.lua 是单文件的？不是应该拆分多个文件更好维护吗？
- kickstart 的主要目的是教学和提供参考，让用户可以一键 git clone 来快速起步。
  等你熟悉了 Neovim 和 Lua，可以考虑拆分配置。
  有人做了一个拆分版的 fork，功能一样，推荐看看：
  - kickstart-modular.nvim
- 相关讨论参考：
  - Restructure the configuration
  - Reorganize init.lua into a multi-file setup

安装指南（Install Recipes）

下面是各操作系统下 Neovim 和依赖的安装方法。

完成后接着进行安装 Kickstart。

Windows 安装

使用 Microsoft C++ Build Tools 和 CMake

安装可能需要 CMake 和 Microsoft C++ Build Tools。
需要配置 telescope-fzf-native 插件的 build 命令，详情见：
telescope-fzf-native 安装文档

lua
{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }

使用 gcc/make 和 chocolatey

你也可以使用 gcc 和 make，更方便，不用改配置。推荐使用 choco 安装： 1. 安装 chocolatey：
可以按照官网教程，也可以用 winget，在 cmd（管理员权限）中运行： winget install --accept-source-agreements chocolatey.chocolatey 2. 用 choco 安装依赖，重新打开一个 cmd（以管理员权限）： choco install -y neovim git ripgrep wget fd unzip gzip mingw make

WSL (Windows 子系统 Linux)

wsl --install
wsl
sudo add-apt-repository ppa:neovim-ppa/unstable -y
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip neovim

Linux 安装

Ubuntu 安装步骤

sudo add-apt-repository ppa:neovim-ppa/unstable -y
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip neovim

Debian 安装步骤

sudo apt update
sudo apt install make gcc ripgrep unzip git xclip curl

# 安装最新版 nvim
curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux-x86_64.tar.gz
sudo rm -rf /opt/nvim-linux-x86_64
sudo mkdir -p /opt/nvim-linux-x86_64
sudo chmod a+rX /opt/nvim-linux-x86_64
sudo tar -C /opt -xzf nvim-linux-x86_64.tar.gz

# 添加软链接
sudo ln -sf /opt/nvim-linux-x86_64/bin/nvim /usr/local/bin/

Fedora 安装步骤

sudo dnf install -y gcc make git ripgrep fd-find unzip neovim

Arch 安装步骤

sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim

简介

安装