This repository was archived by the owner on Nov 30, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathmy-template-docs.txt
More file actions
70 lines (46 loc) · 2.3 KB
/
Copy pathmy-template-docs.txt
File metadata and controls
70 lines (46 loc) · 2.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
*my-template-docs.txt* For Neovim >= 0.8.0 Last change: 2023 November 10
==============================================================================
Table of Contents *my-template-docs-table-of-contents*
1. A Neovim Plugin Template |my-template-docs-a-neovim-plugin-template|
- Using it |my-template-docs-a-neovim-plugin-template-using-it|
- Features and structure|my-template-docs-a-neovim-plugin-template-features-and-structure|
==============================================================================
1. A Neovim Plugin Template *my-template-docs-a-neovim-plugin-template*
A template repository for Neovim plugins.
USING IT *my-template-docs-a-neovim-plugin-template-using-it*
Via `gh`
>
$ gh repo create my-plugin -p ellisonleao/nvim-plugin-template
<
Viagithub web page:
Click on `Use this template`
FEATURES AND STRUCTURE*my-template-docs-a-neovim-plugin-template-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 ~
>
.
├── 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
<
==============================================================================
2. Links *my-template-docs-links*
1. *GitHub Workflow Status*: https://img.shields.io/github/actions/workflow/status/ellisonleao/nvim-plugin-template/lint-test.yml?branch=main&style=for-the-badge
2. *Lua*: https://img.shields.io/badge/Made%20with%20Lua-blueviolet.svg?style=for-the-badge&logo=lua
3. **: https://docs.github.com/assets/cb-36544/images/help/repository/use-this-template-button.png
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
vim:tw=78:ts=8:noet:ft=help:norl: