Skip to content

Commit 988044f

Browse files
author
iton0
committed
docs: add header about documentation
Based on #1285
1 parent 3d81f51 commit 988044f

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,15 @@ nvim
103103
That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
104104
current plugin status. Hit `q` to close the window.
105105

106+
#### Read The Friendly Documentation
107+
106108
Read through the `init.lua` file in your configuration folder for more
107109
information about extending and exploring Neovim. That also includes
108110
examples of adding popularly requested plugins.
109111

112+
> [!NOTE]
113+
> For more information about a particular plugin check its repository's documentation.
114+
110115

111116
### Getting Started
112117

@@ -135,7 +140,7 @@ examples of adding popularly requested plugins.
135140
* The main purpose of kickstart is to serve as a teaching tool and a reference
136141
configuration that someone can easily use to `git clone` as a basis for their own.
137142
As you progress in learning Neovim and Lua, you might consider splitting `init.lua`
138-
into smaller parts. A fork of kickstart that does this while maintaining the
143+
into smaller parts. A fork of kickstart that does this while maintaining the
139144
same functionality is available here:
140145
* [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)
141146
* Discussions on this topic can be found here:

0 commit comments

Comments
 (0)