Skip to content
This repository was archived by the owner on Nov 30, 2025. It is now read-only.

Commit 0022790

Browse files
auto-generate vimdoc
1 parent 49e9938 commit 0022790

1 file changed

Lines changed: 70 additions & 0 deletions

File tree

doc/my-template-docs.txt

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
*my-template-docs.txt* For Neovim >= 0.8.0 Last change: 2023 July 27
2+
3+
==============================================================================
4+
Table of Contents *my-template-docs-table-of-contents*
5+
6+
1. A Neovim Plugin Template |my-template-docs-a-neovim-plugin-template|
7+
- Using it |my-template-docs-a-neovim-plugin-template-using-it|
8+
- Features and structure|my-template-docs-a-neovim-plugin-template-features-and-structure|
9+
10+
==============================================================================
11+
1. A Neovim Plugin Template *my-template-docs-a-neovim-plugin-template*
12+
13+
14+
15+
A template repository for Neovim plugins.
16+
17+
18+
USING IT *my-template-docs-a-neovim-plugin-template-using-it*
19+
20+
Via `gh`
21+
22+
>
23+
$ gh repo create my-plugin -p ellisonleao/nvim-plugin-template
24+
<
25+
26+
Viagithub web page:
27+
28+
Click on `Use this template`
29+
30+
31+
32+
33+
FEATURES AND STRUCTURE*my-template-docs-a-neovim-plugin-template-features-and-structure*
34+
35+
- 100% Lua
36+
- Github actions for:
37+
- running tests using plenary.nvim <https://github.com/nvim-lua/plenary.nvim> and busted <https://olivinelabs.com/busted/>
38+
- check for formatting errors (Stylua)
39+
- vimdocs autogeneration from README.md file
40+
- luarocks release (LUAROCKS_API_KEY secret configuration required)
41+
42+
43+
PLUGIN STRUCTURE ~
44+
45+
>
46+
.
47+
lua
48+
   plugin_name
49+
      module.lua
50+
   plugin_name.lua
51+
Makefile
52+
plugin
53+
   plugin_name.lua
54+
README.md
55+
tests
56+
   minimal_init.lua
57+
   plugin_name
58+
   plugin_name_spec.lua
59+
<
60+
61+
==============================================================================
62+
2. Links *my-template-docs-links*
63+
64+
1. *GitHub Workflow Status*: https://img.shields.io/github/actions/workflow/status/ellisonleao/nvim-plugin-template/default.yml?branch=main&style=for-the-badge
65+
2. *Lua*: https://img.shields.io/badge/Made%20with%20Lua-blueviolet.svg?style=for-the-badge&logo=lua
66+
3. **: https://docs.github.com/assets/cb-36544/images/help/repository/use-this-template-button.png
67+
68+
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
69+
70+
vim:tw=78:ts=8:noet:ft=help:norl:

0 commit comments

Comments
 (0)