Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 0 additions & 35 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

8 changes: 0 additions & 8 deletions .github/pull_request_template.md

This file was deleted.

3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
.metals
tags
test.sh
.luarc.json
nvim

spell/
lazy-lock.json
.DS_Store
93 changes: 49 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
# kickstart.nvim

## Introduction

A starting point for Neovim that is:

* Small
* Single-file
* Completely Documented

**NOT** a Neovim distribution, but instead a starting point for your configuration.
# Florian Teichs fork of kickstart.nvim

## Installation

Expand Down Expand Up @@ -53,28 +43,12 @@ Neovim's configurations are located under the following paths, depending on your

#### Recommended Step

[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo
so that you have your own copy that you can modify, then install by cloning the
fork to your machine using one of the commands below, depending on your OS.

> [!NOTE]
> Your fork's URL will be something like this:
> `https://github.com/<your_github_username>/kickstart.nvim.git`

You likely want to remove `lazy-lock.json` from your fork's `.gitignore` file
too - it's ignored in the kickstart repo to make maintenance easier, but it's
[recommended to track it in version control](https://lazy.folke.io/usage/lockfile).

#### Clone kickstart.nvim

> [!NOTE]
> If following the recommended step above (i.e., forking the repo), replace
> `nvim-lua` with `<your_github_username>` in the commands below

<details><summary> Linux and Mac </summary>

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

</details>
Expand All @@ -84,13 +58,13 @@ git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HO
If you're using `cmd.exe`:

```
git clone https://github.com/nvim-lua/kickstart.nvim.git "%localappdata%\nvim"
git clone https://github.com/FlorianTeich/kickstart.nvim.git "%localappdata%\nvim"
```

If you're using `powershell.exe`

```
git clone https://github.com/nvim-lua/kickstart.nvim.git "${env:LOCALAPPDATA}\nvim"
git clone https://github.com/FlorianTeich/kickstart.nvim.git "${env:LOCALAPPDATA}\nvim"
```

</details>
Expand All @@ -106,20 +80,6 @@ nvim
That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
the current plugin status. Hit `q` to close the window.

#### Read The Friendly Documentation

Read through the `init.lua` file in your configuration folder for more
information about extending and exploring Neovim. That also includes
examples of adding popularly requested plugins.

> [!NOTE]
> For more information about a particular plugin check its repository's documentation.


### Getting Started

[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)

### FAQ

* What should I do if I already have a pre-existing Neovim configuration?
Expand Down Expand Up @@ -239,3 +199,48 @@ sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim
```
</details>

## Keymaps

| Mode | Keys | Action | Description |
| ------------ | ------------ | --------------------------- | ----------------------------- |
| **Normal** | `<Esc>` | `:nohlsearch` | Clear search highlights |
| **Normal** | `<leader>q` | `vim.diagnostic.setloclist` | Open diagnostic quickfix list |
| **Terminal** | `<Esc><Esc>` | `<C-\><C-n>` | Exit terminal mode |
| **Normal** | `<C-h>` | `<C-w><C-h>` | Move focus to left split |
| **Normal** | `<C-l>` | `<C-w><C-l>` | Move focus to right split |
| **Normal** | `<C-j>` | `<C-w><C-j>` | Move focus to lower split |
| **Normal** | `<C-k>` | `<C-w><C-k>` | Move focus to upper split |


| Mode | Keys | Telescope Action | Description |
| ---------- | ------------------ | ---------------------------- | ------------------------------ |
| **Normal** | `<leader>sh` | `help_tags` | Search help |
| **Normal** | `<leader>sk` | `keymaps` | Search keymaps |
| **Normal** | `<leader>sf` | `find_files` | Search files |
| **Normal** | `<leader>ss` | `builtin` | Search Telescope pickers |
| **Normal** | `<leader>sw` | `grep_string` | Search word under cursor |
| **Normal** | `<leader>sg` | `live_grep` | Grep search |
| **Normal** | `<leader>sd` | `diagnostics` | Search diagnostics |
| **Normal** | `<leader>sr` | `resume` | Resume last Telescope search |
| **Normal** | `<leader>s.` | `oldfiles` | Search recent files |
| **Normal** | `<leader><leader>` | `buffers` | Find buffers |
| **Normal** | `<leader>/` | `current_buffer_fuzzy_find` | Fuzzy find in current buffer |
| **Normal** | `<leader>s/` | Live grep open files | Grep through open files only |
| **Normal** | `<leader>sn` | `find_files` (Neovim config) | Search Neovim config directory |

| Mode | Keys | Action | Description |
| ------------------- | ------------ | ------------------------------- | --------------------------------------- |
| **Normal** | `grn` | `vim.lsp.buf.rename` | Rename symbol |
| **Normal / Visual** | `gra` | `vim.lsp.buf.code_action` | Code actions |
| **Normal** | `grr` | `lsp_references` | Find references |
| **Normal** | `gri` | `lsp_implementations` | Go to implementation |
| **Normal** | `grd` | `lsp_definitions` | Go to definition |
| **Normal** | `grD` | `vim.lsp.buf.declaration` | Go to declaration |
| **Normal** | `gO` | `lsp_document_symbols` | Document symbols |
| **Normal** | `gW` | `lsp_dynamic_workspace_symbols` | Workspace symbols |
| **Normal** | `grt` | `lsp_type_definitions` | Go to type definition |
| **Normal** | `<leader>th` | Toggle inlay hints | Toggle LSP inlay hints (when supported) |

| Mode | Keys | Action | Description |
| --------------------------- | ----------- | ---------------- | --------------------- |
| **All modes (`mode = ''`)** | `<leader>f` | `conform.format` | Format current buffer |
24 changes: 0 additions & 24 deletions doc/kickstart.txt

This file was deleted.

3 changes: 0 additions & 3 deletions doc/tags

This file was deleted.

Loading
Loading