Skip to content

Commit cc51672

Browse files
chore(doc): auto generate docs
1 parent b7ba151 commit cc51672

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

doc/nvim-plugin-template.nvim.txt

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
*nvim-plugin-template.nvim.txt* For NVIM v0.8.0 Last change: 2025 February 05
2+
3+
==============================================================================
4+
Table of Contents *nvim-plugin-template.nvim-table-of-contents*
5+
6+
1. nvim-plugin-template |nvim-plugin-template.nvim-nvim-plugin-template|
7+
- Usage |nvim-plugin-template.nvim-nvim-plugin-template-usage|
8+
- Format |nvim-plugin-template.nvim-nvim-plugin-template-format|
9+
- Test |nvim-plugin-template.nvim-nvim-plugin-template-test|
10+
- CI |nvim-plugin-template.nvim-nvim-plugin-template-ci|
11+
- More |nvim-plugin-template.nvim-nvim-plugin-template-more|
12+
- License MIT |nvim-plugin-template.nvim-nvim-plugin-template-license-mit|
13+
14+
==============================================================================
15+
1. nvim-plugin-template *nvim-plugin-template.nvim-nvim-plugin-template*
16+
17+
Neovim plugin template; includes automatic documentation generation from
18+
README, integration tests with Busted, and linting with Stylua
19+
20+
21+
USAGE *nvim-plugin-template.nvim-nvim-plugin-template-usage*
22+
23+
1. Click `use this template` button generate a repo on your github.
24+
2. Clone your plugin repo. Open terminal then cd plugin directory.
25+
3. Run `python3 rename.py your-plugin-name`. This will replace all `nvim-plugin-template` to your `plugin-name`.
26+
Then it will prompt you input `y` or `n` to remove example codes in `init.lua` and
27+
`test/plugin_spec.lua`. If you are familiar this repo just input `y`. If you are looking at this template for the first time I suggest you inspect the contents. After this step `rename.py` will also auto-remove.
28+
29+
Now you have a clean plugin environment. Enjoy!
30+
31+
32+
FORMAT *nvim-plugin-template.nvim-nvim-plugin-template-format*
33+
34+
The CI uses `stylua` to format the code; customize the formatting by editing
35+
`.stylua.toml`.
36+
37+
38+
TEST *nvim-plugin-template.nvim-nvim-plugin-template-test*
39+
40+
See Running tests locally
41+
<https://github.com/nvim-neorocks/nvim-busted-action?tab=readme-ov-file#running-tests-locally>
42+
43+
44+
CI *nvim-plugin-template.nvim-nvim-plugin-template-ci*
45+
46+
- Auto generates doc from README.
47+
- Runs the nvim-busted-action <https://github.com/nvim-neorocks/nvim-busted-action> for test.
48+
- Lints with `stylua`.
49+
50+
51+
MORE *nvim-plugin-template.nvim-nvim-plugin-template-more*
52+
53+
To see this template in action, take a look at my other plugins.
54+
55+
56+
LICENSE MIT *nvim-plugin-template.nvim-nvim-plugin-template-license-mit*
57+
58+
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
59+
60+
vim:tw=78:ts=8:noet:ft=help:norl:

0 commit comments

Comments
 (0)