newbie
/
slot.nvim
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore(doc): auto generate docs

This commit is contained in:
github-actions[bot] 2023-06-18 06:39:11 +00:00
parent ab9a28a3e1
commit 41add0f7d1
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/nvim-plugin-template.txt
View File

@ -1,4 +1,4 @@
*nvim-plugin-template.txt* For NVIM v0.8.0 Last change: 2023 June 16 *nvim-plugin-template.txt* For NVIM v0.8.0 Last change: 2023 June 18
============================================================================== ==============================================================================
Table of Contents *nvim-plugin-template-table-of-contents* Table of Contents *nvim-plugin-template-table-of-contents*
@ -19,10 +19,15 @@ neovim plugin template integration test and doc publish
USAGE *nvim-plugin-template-nvim-plugin-template-usage* USAGE *nvim-plugin-template-nvim-plugin-template-usage*
click `use this template` button generate a repo on your github. then clone 1. click `use this template` button generate a repo on your github.
your plugin repo.open terminal then cd plugin directory , run `python3 2. clone your plugin repo.open terminal then cd plugin directory.
rename.py your-plugin-name` this will replace all `nvim-plugin-template` to 3. run `python3 rename.py your-plugin-name` this will replace all `nvim-plugin-template` to your `pluing-name`.
your `pluing-name`. Then develope your plugin. Enjoy! then it will prompt you input `y` or `n` to remove example codes in `init.lua` and
`test/plugin_spec.lua`. if you are familiar this repo just input y. if you are first look at this
template I suggest you look at them first. after these step the `rename.py` will also auto
remove.
now you have a clean plugin env. enjoy!
FORMAT *nvim-plugin-template-nvim-plugin-template-format* FORMAT *nvim-plugin-template-nvim-plugin-template-format*