-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
02e8591
commit 4510029
Showing
1 changed file
with
5 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,47 +1,13 @@ | ||
# A Neovim Plugin Template | ||
# selfhelp.nvim | ||
|
||
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ellisonleao/nvim-plugin-template/lint-test.yml?branch=main&style=for-the-badge) | ||
![Lua](https://img.shields.io/badge/Made%20with%20Lua-blueviolet.svg?style=for-the-badge&logo=lua) | ||
|
||
A template repository for Neovim plugins. | ||
A simple Neovim plugin to display a floating help dialog displaying your key mappings | ||
|
||
## Using it | ||
|
||
Via `gh`: | ||
|
||
``` | ||
$ gh repo create my-plugin -p ellisonleao/nvim-plugin-template | ||
``` | ||
|
||
Via github web page: | ||
|
||
Click on `Use this template` | ||
|
||
![](https://docs.github.com/assets/cb-36544/images/help/repository/use-this-template-button.png) | ||
|
||
## Features and structure | ||
|
||
- 100% Lua | ||
- Github actions for: | ||
- running tests using [plenary.nvim](https://github.com/nvim-lua/plenary.nvim) and [busted](https://olivinelabs.com/busted/) | ||
- check for formatting errors (Stylua) | ||
- vimdocs autogeneration from README.md file | ||
- luarocks release (LUAROCKS_API_KEY secret configuration required) | ||
|
||
### Plugin structure | ||
## Installation | ||
|
||
Lazy.nvim | ||
``` | ||
. | ||
├── lua | ||
│ ├── plugin_name | ||
│ │ └── module.lua | ||
│ └── plugin_name.lua | ||
├── Makefile | ||
├── plugin | ||
│ └── plugin_name.lua | ||
├── README.md | ||
├── tests | ||
│ ├── minimal_init.lua | ||
│ └── plugin_name | ||
│ └── plugin_name_spec.lua | ||
{ 'jtubbenhauer/selfhelp.nvim' } | ||
``` |