> A catch phrase that describes your plugin.
> Drag your video (<10MB) here to host it for free on GitHub.
Videos don't work on GitHub mobile, so a GIF alternative can help users.
Write short sentences describing your plugin features
- FEATURE 1
- FEATURE ..
- FEATURE N
Package manager | Snippet |
---|---|
-- stable version
use {"YOUR_REPOSITORY_NAME", tag = "*" }
-- dev version
use {"YOUR_REPOSITORY_NAME"} |
|
-- stable version
Plug "YOUR_REPOSITORY_NAME", { "tag": "*" }
-- dev version
Plug "YOUR_REPOSITORY_NAME" |
|
-- stable version
require("lazy").setup({{"YOUR_REPOSITORY_NAME", version = "*"}})
-- dev version
require("lazy").setup({"YOUR_REPOSITORY_NAME"}) |
Describe how to use the plugin the simplest way
The configuration list sometimes become cumbersome, making it folded by default reduce the noise of the README file.
Click to unfold the full list of options with their default values
Note: The options are also available in Neovim by calling
:h your-plugin-name.options
require("your-plugin-name").setup({
-- you can copy the full list from lua/your-plugin-name/config.lua
})
Command | Description |
---|---|
:Toggle |
Enables the plugin. |
PRs and issues are always welcome. Make sure to provide as much context as possible when opening one.
You can find guides and showcase of the plugin on the Wiki
If alternatives of your plugin exist, you can provide some pros/cons of using yours over the others.