Skip to content

Commit 98bc49f

Browse files
committed
feat(readme): add configuration section with plugin links
Adds a new "Configuration" section to the README.md file. This section provides direct links to the configuration of each plugin, whether it's located in the `init.lua` file or in a dedicated file within the `lua/kickstart/plugins` directory. This makes it easier for users to navigate and understand the project's structure.
1 parent ffe2ab0 commit 98bc49f

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,35 @@ examples of adding popularly requested plugins.
150150
* [Restructure the configuration](https://github.com/nvim-lua/kickstart.nvim/issues/218)
151151
* [Reorganize init.lua into a multi-file setup](https://github.com/nvim-lua/kickstart.nvim/pull/473)
152152
153+
154+
## Configuration
155+
156+
This section provides quick links to the configuration of each plugin.
157+
158+
### Plugins configured in `init.lua`
159+
160+
- [guess-indent.nvim](init.lua#L303)
161+
- [gitsigns.nvim](init.lua#L325)
162+
- [which-key.nvim](init.lua#L349)
163+
- [telescope.nvim](init.lua#L413)
164+
- [lazydev.nvim](init.lua#L523)
165+
- [nvim-lspconfig](init.lua#L535)
166+
- [conform.nvim](init.lua#L807)
167+
- [blink.cmp](init.lua#L849)
168+
- [tokyonight.nvim](init.lua#L962)
169+
- [todo-comments.nvim](init.lua#L981)
170+
- [mini.nvim](init.lua#L983)
171+
- [nvim-treesitter](init.lua#L1018)
172+
173+
### Plugins with dedicated configuration files
174+
175+
- [autopairs.lua](lua/kickstart/plugins/autopairs.lua)
176+
- [debug.lua](lua/kickstart/plugins/debug.lua)
177+
- [gitsigns.lua](lua/kickstart/plugins/gitsigns.lua)
178+
- [indent_line.lua](lua/kickstart/plugins/indent_line.lua)
179+
- [lint.lua](lua/kickstart/plugins/lint.lua)
180+
- [neo-tree.lua](lua/kickstart/plugins/neo-tree.lua)
181+
153182
### Install Recipes
154183
155184
Below you can find OS specific install instructions for Neovim and dependencies.

0 commit comments

Comments
 (0)