Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
148 commits
Select commit Hold shift + click to select a range
5623cd0
Added lua/lazy-bootstrap.lua
dam9000 Oct 22, 2023
bc8966a
Added lua/lazy-plugins.lua
dam9000 Oct 22, 2023
7070190
Added lua/options.lua
dam9000 Oct 22, 2023
79e010e
Added lua/keymaps.lua
dam9000 Oct 22, 2023
7a354c7
Added lua/telescope-setup.lua
dam9000 Oct 22, 2023
a13e1b0
Added lua/treesitter-setup.lua
dam9000 Oct 22, 2023
cff9b13
Added lua/lsp-setup.lua
dam9000 Oct 22, 2023
3ab1c22
Added lua/cmp-setup.lua
dam9000 Oct 22, 2023
d6466a7
Update README.md - remove single-file
dam9000 Oct 22, 2023
ae9617b
Update README.md - kickstart-modular fork
dam9000 Oct 22, 2023
0d1f2c5
Merge remote-tracking branch 'upstream/master'
dam9000 Nov 7, 2023
8801505
Merge remote-tracking branch 'upstream/master'
dam9000 Nov 7, 2023
37d6282
init.lua: update section comments to match upstream
dam9000 Nov 7, 2023
2e401e0
Merge remote-tracking branch 'upstream/master'
dam9000 Nov 12, 2023
78e59cf
Merge remote-tracking branch 'upstream/master'
dam9000 Nov 14, 2023
1ef3d22
Merge remote-tracking branch 'upstream/master'
dam9000 Nov 24, 2023
111a244
Merge remote-tracking branch 'upstream/master' (updated README.md)
dam9000 Nov 30, 2023
c1e9a3b
Merge 'upstream/master' (Use alias instead of a wrapper script)
dam9000 Dec 1, 2023
207ef6a
Merge 'upstream/master' github action stylua check
dam9000 Dec 2, 2023
a54945c
Merge 'upstream/master' Run stylua
dam9000 Dec 3, 2023
5db82f3
Merge 'upstream/master' keymaps for telescope and gitsigns
dam9000 Dec 4, 2023
cbaae1e
Run stylua on init.lua
dam9000 Dec 5, 2023
91499eb
Merge 'upstream/master' feat(cmp): path completion feature
dam9000 Dec 8, 2023
bc75e6a
Merge 'upstream/master' Switch cmp up mapping from C-d to C-b
dam9000 Dec 22, 2023
f6f5537
Minor changes to README to reflect the modular repo (#3)
pjaglom Dec 22, 2023
49b21ae
README.md: removed some trailing spaces
dam9000 Dec 22, 2023
13c28e8
Merge 'upstream/master' fix: restore mason config timing for dap startup
dam9000 Dec 24, 2023
0be3fcf
fix: incorrect reference to init.lua in README.md
vneogi199 Dec 31, 2023
7832207
Merge 'upstream/master' Move video up on the README.md page
dam9000 Jan 3, 2024
251779f
Merge 'upstream/master' Improve stylua github workflow
dam9000 Jan 3, 2024
d81c032
Merge 'upstream/master' Add Missing Fields to Treesitter Config to Re…
dam9000 Jan 8, 2024
70683b1
Merge 'upstream/master' README.md: rename the duplicate "Introduction…
dam9000 Jan 9, 2024
cc5b4c6
Merge 'upstream/master' Removed duplicate line
dam9000 Jan 12, 2024
460978b
Merge 'upstream/master' Set status line theme to the global colorscheme
dam9000 Jan 29, 2024
cc0baad
Merge 'upstream/master' Add Onedark Style
dam9000 Jan 29, 2024
58284c2
Merge 'upstream/master' stylua workflow only on official kickstart repo
dam9000 Feb 1, 2024
7d67515
Merge 'upstream/master' feat: added contexts for code action - source…
dam9000 Feb 3, 2024
281b729
Merge 'upstream/master' Add hints for new neovim users to learn how t…
dam9000 Feb 4, 2024
4e7e664
Merge 'upstream/master' Add Build Step to LuaSnip
dam9000 Feb 5, 2024
1ff3a15
Merge 'upstream/master' rewrite: slimmer, trimmer and more lazy kicks…
dam9000 Feb 26, 2024
f94c10e
Merge 'upstream/master' fixups (autocommand, auto_install)
dam9000 Feb 26, 2024
d172893
README.md: minor update to the modular fork note
dam9000 Feb 26, 2024
54df289
Merge 'upstream/master' add plugin specs docstring, remove lazy.nvim …
dam9000 Feb 27, 2024
d6d745d
Merge 'upstream/master' Change mini.statusline location format to LIN…
dam9000 Feb 28, 2024
b650582
Merge 'upstream/master' fixup style, lua lsp snippets
dam9000 Mar 1, 2024
df166c3
Merge 'upstream/master' chore: fix typos
dam9000 Mar 1, 2024
de8986f
Merge 'upstream/master' VimEnter, win install, custom/plugins note
dam9000 Mar 3, 2024
09093d4
Merge 'upstream/master' fix: checkhealth reported nvim version
dam9000 Mar 4, 2024
0ff7758
Merge 'upstream/master' cursor location, trailing spaces, new youtube…
dam9000 Mar 4, 2024
586bdec
Merge 'upstream/master' Add more detail to colorscheme comment
dam9000 Mar 6, 2024
56942ef
Merge 'upstream/master' Make the Nerd Font an optional requirement
dam9000 Mar 6, 2024
3b0a5bb
Merge 'upstream/master' Fix typos and whatnot
dam9000 Mar 8, 2024
8f85ac8
Merge 'upstream' use init for colorscheme
dam9000 Mar 10, 2024
2238a5d
Merge 'upstream' README.md: update neo-tree example - remove legacy s…
dam9000 Mar 11, 2024
7da09ad
Merge 'upstream' rename <C-t>, use opts for treesitter
dam9000 Mar 12, 2024
f02070e
Merge 'upstream' Added folke/neodev.nvim for proper nvim api completi…
dam9000 Mar 12, 2024
55008e9
Merge 'upstream' timeoutlen, cmp scroll, friendly snippets, luasnip, …
dam9000 Mar 15, 2024
1ac2734
Merge 'upstream' conform: disable autoformat on save for specified fi…
dam9000 Mar 15, 2024
7829fe9
Merge 'upstream' README: additional install recipes for various OS
dam9000 Mar 17, 2024
b59b1d2
Merge 'upstream' feat: add linter plugin, lua_ls config comment
dam9000 Mar 18, 2024
d20d58c
Merge 'upstream' Some suggestions and capitalised a few words
dam9000 Mar 18, 2024
01970d6
Merge 'upstream' Add nvim-nio as dependency for nvim-dap-ui
dam9000 Mar 19, 2024
2860431
Merge 'upstream' Update README.md (reordering of recommended steps)
dam9000 Mar 20, 2024
a037d1d
Merge branch 'upstream' README: wrap long lines
dam9000 Mar 22, 2024
dc9eb06
Merge 'upstream' Add luadoc in treesitter, instructions to quit lazy
dam9000 Mar 28, 2024
2cd884a
Merge 'upstream' Add a keymap space-f to format buffer using conform
dam9000 Mar 31, 2024
3d468e9
Merge 'upstream' Don't lazy load conform plugin
dam9000 Apr 1, 2024
0ef9368
Merge 'upstream' README: move backup and paths from external deps to …
dam9000 Apr 1, 2024
e0476d9
Merge 'upstream' Add a pull request template
dam9000 Apr 4, 2024
3348ec2
Merge 'upstream' README: add git to ubuntu install
dam9000 Apr 9, 2024
478a830
Merge 'upstream' README: Arch Install Steps
dam9000 Apr 16, 2024
c0ac446
Merge 'upstream' Comment about nerd font selection.
dam9000 Apr 17, 2024
b6b33e6
Merge 'upstream' prefer_git, inlay hints
dam9000 Apr 17, 2024
3d2daa7
Merge 'upstream' Move plugin examples from README to optional plugin …
dam9000 Apr 17, 2024
517da30
Merge 'upstream' Add gitsigns recommended keymaps
dam9000 Apr 18, 2024
b8b2e88
Merge 'upstream' fix: restore Mason config timing for DAP startup
dam9000 Apr 20, 2024
77119da
Merge 'upstream' Update README.md Debian install instructions
dam9000 Apr 20, 2024
9813433
Merge 'upstream' example of the classic complete keymaps
dam9000 Apr 20, 2024
74136a1
Merge 'upstream' Fix deprecation notice of inlay hints
dam9000 Apr 22, 2024
b939e2f
Merge 'upstream' Fix highlight errors when lsp crash or stop
dam9000 Apr 22, 2024
77dbcfa
Merge 'upstream' fix: highlight group clear on each attach, README
dam9000 Apr 22, 2024
60d893f
Merge 'upstream' README: add clipboard tool dependency
dam9000 Apr 28, 2024
9fb3891
Merge 'upstream' Move LspDetach handler near kickstart-lsp-highlight …
dam9000 May 2, 2024
f28bfcd
Merge 'upstream' Add diff to treesitter's ensure_installed languages
dam9000 May 6, 2024
bd53ce0
Merge 'upstream' fix: debug.lua
dam9000 May 8, 2024
01a18a1
Merge 'upstream' debug.lua: Automatically set detached state as needed.
dam9000 May 10, 2024
64597b0
Merge 'upstream' which-key v3 update
dam9000 Jul 17, 2024
a6442e8
Merge 'upstream' fix(lazy): added error handling for bootstrap
dam9000 Jul 17, 2024
e1d6094
Merge 'upstream' Neovim 0.10 updates and more
dam9000 Jul 22, 2024
5a2930f
Merge 'upstream' conform warning, redundant hlsearch
dam9000 Jul 28, 2024
0a274ab
Merge 'upstream' refactor lazydev, defer clipboard
dam9000 Jul 29, 2024
198460c
Merge 'upstream' nvim-lspconfig cmp-nvim-lsp, treesitter prefer_git
dam9000 Jul 31, 2024
e921346
Merge 'upstream' refactor treesitter, which-key, uv/loop, update README
dam9000 Aug 23, 2024
0692979
Merge 'upstream' Include visual mode in LSP code action keymap
dam9000 Aug 25, 2024
7d83a27
Merge 'upstream' conform, readme, neo-tree silent
dam9000 Aug 26, 2024
7e11e8a
Merge 'upstream' cleanup: refactor which-key configuration
dam9000 Aug 26, 2024
3a01797
Merge 'upstream' Fix the which-key spec issue caused by recent cleanup
dam9000 Aug 26, 2024
1695a1d
Merge 'upstream' feat: update references of tsserver to ts_ls
dam9000 Sep 10, 2024
c0a254f
Merge 'upstream' fix: update lazy uninstall information link
dam9000 Sep 24, 2024
ee40a0e
Merge 'upstream' 5 changes from 2024-10-30
dam9000 Oct 31, 2024
46093fe
Merge 'upstream': diagnostic-signs, nvim-dap lazy, which-key typo
dam9000 Nov 20, 2024
74b8749
Merge 'upstream': updated comments
dam9000 Dec 12, 2024
7bd1384
Merge 'upstream': fix typo opt -> opts
dam9000 Dec 13, 2024
5d699a0
Merge 'upstream': make visual mode descriptions consistent with norma…
dam9000 Dec 15, 2024
5f3310d
Merge 'upstream': 3 misc commits
dam9000 Dec 30, 2024
e71cef8
Merge 'upstream': fix: prevent mason setup from being run twice
dam9000 Jan 8, 2025
a0a5e06
Merge 'upstream': luv, doc updates
dam9000 Jan 17, 2025
abdbfce
chore(docs): Update README.md (#1344)
rnevius Feb 15, 2025
71ad926
docs: clarify using opts = {} vs config = function() ... require('plu…
bleacheda Feb 15, 2025
94f551b
fix (#1319): gitsigns deprecated functions (#1321)
ErlanRG Feb 15, 2025
d2c0068
Add a blurb about installing missing emoji on Ubuntu
feoh Feb 17, 2025
db78c0b
fix: arguments for the `vim.lsp.Client.supports_method` method (#1356)
jrentlez Feb 17, 2025
07778f6
Merge 'upstream': docs, gitsigns, emoji, lsp
dam9000 Feb 17, 2025
76e06fe
feat(diagnostic): add diagnostic config (#1335)
gelocraft Feb 17, 2025
15e019c
Merge 'upstream': feat(diagnostic): add diagnostic config
dam9000 Feb 17, 2025
ebca680
perf: load tokyonight.nvim in the intended way (#1360)
warbacon Feb 18, 2025
282cbb9
feat: add basic function signature help (#1358)
rfletchr Feb 18, 2025
7c49ba1
Fix: fix the cmp-nvim-lsp-signature-help link (#1363)
aryan-rajoria Feb 18, 2025
e64aa51
fix: regression introduced in db78c0b217fd9525e2cbcbffd18abbbbddc75b2…
jrentlez Feb 18, 2025
ea60b2b
Remove duplicate cmp-path (#1369)
aripollak Feb 19, 2025
34e7d29
Propsed fix for init.lua warnings as per https://github.com/nvim-lua/…
feoh Feb 19, 2025
af749bd
Merge 'upstream': various fixes
dam9000 Feb 19, 2025
38f4744
feat: add `vim.opt.confirm = true` (#1384)
Crypto-Spartan Mar 12, 2025
891bdd8
Merge 'upstream': feat: add `vim.opt.confirm = true`
dam9000 Mar 13, 2025
2abcb39
fix: use correct github abmonition syntax (#1414)
saccarosium Mar 20, 2025
e63bee4
Merge 'upstream': fix: use correct github abmonition syntax
dam9000 Mar 23, 2025
5e2d7e1
changed Conform's format_on_save lambda so that buffers that match di…
RulentWave Mar 24, 2025
e947649
feat(keymap): move windows without `<C-w>` (#1368)
sand4rt Mar 24, 2025
153ec74
Merge 'upstream': move windows, conform format_on_save
dam9000 Mar 24, 2025
8a5a52f
fix: minor misspellings (#1450)
dasvh Apr 9, 2025
1a5787b
Change LSP Keybindings to Match the Default `gr` Bindings Introduced …
theopn Apr 9, 2025
9929044
Remove Telescope `0.1` branch lock (#1448)
vaporif Apr 9, 2025
f36056b
Merge 'upstream': telescope branch, lsp keybindings, spelling
dam9000 Apr 9, 2025
d350db2
feat: switch nvim-cmp for blink.cmp (#1426)
saghen Apr 9, 2025
b226b49
Merge 'upstream': feat: switch nvim-cmp for blink.cmp
dam9000 Apr 15, 2025
f872737
remove cmp.lua which was replaced with blink-cmp.lua
dam9000 Apr 15, 2025
76cb865
Change to Mason's new address (#1516)
guru245 May 9, 2025
2b2f0f8
feat: switch vim-sleuth for guess-indent.nvim (#1512)
guru245 May 11, 2025
c92ea7c
Replace vim.opt with vim.o (#1495)
oriori1703 May 11, 2025
fb73617
don't lazy-load neo-tree so netrw hijacking on startup works (#1489)
pynappo May 11, 2025
f5a9f9c
README: mention fd-find in requirements (#1477)
dam9000 May 11, 2025
6ba2408
fix: rename vim.highlight.on_yank to vim.hl.on_yank (#1482)
omrisarig13 May 11, 2025
726fabc
Merge 'upstream': various changes 2025-05-10
dam9000 May 12, 2025
61e8b30
Update windows installation command
jaho5 May 17, 2025
12b545c
Merge branch 'master' into modular-master
mhamza15 May 18, 2025
db38f9d
remove conflicting stuff
mhamza15 May 18, 2025
d3f78db
more changes
mhamza15 May 18, 2025
6b6c1a7
more
mhamza15 May 19, 2025
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
44 changes: 26 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# kickstart.nvim
# kickstart-modular.nvim

## Introduction

*This is a fork of [nvim-lua/kickstart.nvim](https://github.com/nvim-lua/kickstart.nvim) that moves from a single file to a multi file configuration.*

A starting point for Neovim that is:

* Small
* Single-file
* Modular
* Completely Documented

**NOT** a Neovim distribution, but instead a starting point for your configuration.
Expand All @@ -23,22 +25,24 @@ If you are experiencing issues, please make sure you have the latest versions.

External Requirements:
- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation)
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation),
[fd-find](https://github.com/sharkdp/fd#installation)
- Clipboard tool (xclip/xsel/win32yank or other depending on the platform)
- A [Nerd Font](https://www.nerdfonts.com/): optional, provides various icons
- if you have it set `vim.g.have_nerd_font` in `init.lua` to true
- Emoji fonts (Ubuntu only, and only if you want emoji!) `sudo apt install fonts-noto-color-emoji`
- Language Setup:
- If you want to write Typescript, you need `npm`
- If you want to write Golang, you will need `go`
- etc.

> **NOTE**
> [!NOTE]
> See [Install Recipes](#Install-Recipes) for additional Windows and Linux specific notes
> and quick install snippets

### Install Kickstart

> **NOTE**
> [!NOTE]
> [Backup](#FAQ) your previous configuration (if any exists)

Neovim's configurations are located under the following paths, depending on your OS:
Expand All @@ -55,23 +59,24 @@ Neovim's configurations are located under the following paths, depending on your
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**
> [!NOTE]
> Your fork's URL will be something like this:
> `https://github.com/<your_github_username>/kickstart.nvim.git`
> `https://github.com/<your_github_username>/kickstart-modular.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**

> [!NOTE]
> If following the recommended step above (i.e., forking the repo), replace
> `nvim-lua` with `<your_github_username>` in the commands below
> `dam9000` 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/dam9000/kickstart-modular.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
```

</details>
Expand All @@ -81,13 +86,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/dam9000/kickstart-modular.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/dam9000/kickstart-modular.nvim.git "${env:LOCALAPPDATA}\nvim"
```

</details>
Expand Down Expand Up @@ -143,6 +148,9 @@ examples of adding popularly requested plugins.
into smaller parts. A fork of kickstart that does this while maintaining the
same functionality is available here:
* [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)
* *NOTE: This is the fork that splits the configuration into smaller parts.*
The original repo with the single `init.lua` file is available here:
* [kickstart.nvim](https://github.com/nvim-lua/kickstart.nvim)
* Discussions on this topic can be found here:
* [Restructure the configuration](https://github.com/nvim-lua/kickstart.nvim/issues/218)
* [Reorganize init.lua into a multi-file setup](https://github.com/nvim-lua/kickstart.nvim/pull/473)
Expand Down Expand Up @@ -212,14 +220,14 @@ sudo apt update
sudo apt install make gcc ripgrep unzip git xclip curl

# Now we install nvim
curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux64.tar.gz
sudo rm -rf /opt/nvim-linux64
sudo mkdir -p /opt/nvim-linux64
sudo chmod a+rX /opt/nvim-linux64
sudo tar -C /opt -xzf nvim-linux64.tar.gz
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

# make it available in /usr/local/bin, distro installs to /usr/bin
sudo ln -sf /opt/nvim-linux64/bin/nvim /usr/local/bin/
sudo ln -sf /opt/nvim-linux-x86_64/bin/nvim /usr/local/bin/
```
</details>
<details><summary>Fedora Install Steps</summary>
Expand Down
Loading